### Install pluggy-sdk Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Install the Pluggy Node.js SDK using npm. ```bash npm install pluggy-sdk ``` -------------------------------- ### Quickstart Pluggy Client Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Initialize the Pluggy client with your credentials and fetch connectors. ```typescript import { PluggyClient } from 'pluggy-sdk' const client = new PluggyClient({ clientId: process.env.PLUGGY_CLIENT_ID!, clientSecret: process.env.PLUGGY_CLIENT_SECRET!, }) async function main() { // Example: list connectors const connectors = await client.fetchConnectors() console.log('connectors', connectors.length) } main().catch((err) => { console.error(err) process.exitCode = 1 }) ``` -------------------------------- ### Fetch Current API Specification Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Use this GET request to retrieve the OpenAPI specification for the Pluggy API. ```http GET https://api.pluggy.ai/oas3.json ``` -------------------------------- ### TypeScript Type Definition Pattern Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Example of defining TypeScript types for API models, including common fields like IDs, optional, nullable, and date fields. Also shows a pattern for model filters. ```typescript import { PageFilters } from './common' export type ModelName = { /** Primary identifier */ id: string /** Related item ID */ itemId: string /** Optional field */ optionalField?: string /** Nullable field */ nullableField: string | null /** Date field */ createdAt: Date } export type ModelFilters = PageFilters & { /** Custom filter */ customFilter?: string } ``` -------------------------------- ### Node.js Project Build and Test Commands Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Standard npm commands for managing dependencies, building the project, running tests, and linting. ```bash # Install dependencies npm ci ``` ```bash # Build npm run build ``` ```bash # Test npm test ``` ```bash # Lint npm run lint ``` -------------------------------- ### Initialize Pluggy Payments Client Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Initialize the Pluggy Payments client with your credentials. This client is used for payment initiation features. ```typescript import { PluggyPaymentsClient } from 'pluggy-sdk' const payments = new PluggyPaymentsClient({ clientId: process.env.PLUGGY_CLIENT_ID!, clientSecret: process.env.PLUGGY_CLIENT_SECRET!, }) ``` -------------------------------- ### Manage Items Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Create, fetch, and update items using the Pluggy client. Use updateItemMFA when multi-factor authentication is required. ```typescript // Create an item const item = await client.createItem({ connectorId: 123, parameters: { // connector-specific parameters }, }) // Fetch an item const fetched = await client.fetchItem(item.id) // Update item MFA (when required) await client.updateItemMFA(item.id, { // mfa payload from Pluggy }) ``` -------------------------------- ### Manage Webhooks Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Create, fetch, and delete webhooks using the Pluggy client. Ensure the provided URL is accessible for receiving webhook events. ```typescript const webhook = await client.createWebhook({ url: 'https://example.com/webhooks/pluggy', event: 'item.created', }) const webhooks = await client.fetchWebhooks() await client.deleteWebhook(webhook.id) ``` -------------------------------- ### Create a Connect Token Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Generate a connect token using the Pluggy client. Pass any required fields for your integration. ```typescript import { PluggyClient } from 'pluggy-sdk' const client = new PluggyClient({ clientId: process.env.PLUGGY_CLIENT_ID!, clientSecret: process.env.PLUGGY_CLIENT_SECRET!, }) const connectToken = await client.createConnectToken({ // Tip: pass the fields required by your integration // (e.g. options, itemId, connectorId, etc.) }) ``` -------------------------------- ### Fetch Connectors Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Retrieves a list of available connectors from the Pluggy API. ```APIDOC ## Fetch Connectors ### Description Retrieves a list of available connectors. ### Method `client.fetchConnectors()` ### Response Returns an array of connector objects. ``` -------------------------------- ### Create Payment Request Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Initiates a payment request. ```APIDOC ## Create Payment Request ### Description Initiates a payment request with the specified details. ### Method `payments.createPaymentRequest(paymentRequestPayload)` ### Parameters #### Request Body - **paymentRequestPayload** (object) - Required - The payload containing details for the payment request. ``` -------------------------------- ### Create Webhook Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Registers a new webhook to receive event notifications from Pluggy. ```APIDOC ## Create Webhook ### Description Registers a webhook endpoint to receive real-time notifications about specific events. ### Method `client.createWebhook(options)` ### Parameters #### Request Body - **options** (object) - Required - An object containing: - **url** (string) - Required - The URL of the webhook endpoint. - **event** (string) - Required - The event to subscribe to (e.g., 'item.created'). ``` -------------------------------- ### Create Item Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Creates a new item, representing a connection to a specific financial institution for a user. ```APIDOC ## Create Item ### Description Creates a new item, which represents a connection to a financial institution. ### Method `client.createItem(options)` ### Parameters #### Request Body - **options** (object) - Required - An object containing: - **connectorId** (number) - The ID of the connector to use. - **parameters** (object) - Connector-specific parameters required for the connection. ``` -------------------------------- ### Fetch Accounts and Transactions with Pagination Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Fetch accounts for an item and retrieve transactions with pagination options. Use fetchAllTransactions to iterate through all pages. ```typescript const accounts = await client.fetchAccounts(item.id) const firstPage = await client.fetchTransactions({ itemId: item.id, page: 1, pageSize: 20, }) // If you need to iterate across all pages: const all = await client.fetchAllTransactions({ itemId: item.id, pageSize: 500, }) ``` -------------------------------- ### Create Connect Token Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Generates a token required for establishing a connection to a financial institution. ```APIDOC ## Create Connect Token ### Description Creates a connect token, which is used to initiate the connection process with a financial institution. ### Method `client.createConnectToken(options)` ### Parameters #### Request Body - **options** (object) - Optional - An object that can contain fields like `itemId`, `connectorId`, etc., to pre-configure the token. ### Request Example ```ts const connectToken = await client.createConnectToken({ // Tip: pass the fields required by your integration // (e.g. options, itemId, connectorId, etc.) }) ``` ``` -------------------------------- ### Fetch Connectors Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves a list of available financial connectors or details for a specific connector. ```APIDOC ## GET /connectors ### Description Fetches a list of available financial connectors or details for a specific connector. ### Method GET ### Endpoint /connectors ### Parameters #### Query Parameters - **id** (string) - Optional - The ID of the connector to fetch. ### Response #### Success Response (200) - **data** (array) - An array of connector objects or a single connector object if an ID is provided. ``` -------------------------------- ### Pluggy Node SDK Client Methods Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md These methods abstract common HTTP request patterns for interacting with the Pluggy API. Use these for fetching, creating, updating, and deleting resources. ```typescript async fetchModels(itemId: string, options: ModelFilters = {}): Promise> { return await this.createGetRequest('models', { ...options, itemId }) } ``` ```typescript async fetchModel(id: string): Promise { return await this.createGetRequest(`models/${id}`) } ``` ```typescript async createModel(payload: CreateModelPayload): Promise { return await this.createPostRequest('models', null, payload) } ``` ```typescript async updateModel(id: string, payload: UpdateModelPayload): Promise { return await this.createPatchRequest(`models/${id}`, null, payload) } ``` ```typescript async deleteModel(id: string): Promise { return await this.createDeleteRequest(`models/${id}`) } ``` -------------------------------- ### Create Model Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Creates a new model with the provided payload. ```APIDOC ## POST /models ### Description Creates a new model. ### Method POST ### Endpoint /models ### Parameters #### Request Body - **payload** (CreateModelPayload) - Required - The data required to create the model. ### Response #### Success Response (200) - **data** (Model) - The newly created Model object. ``` -------------------------------- ### Fetch Webhooks Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Retrieves a list of all registered webhooks. ```APIDOC ## Fetch Webhooks ### Description Retrieves a list of all currently registered webhooks. ### Method `client.fetchWebhooks()` ``` -------------------------------- ### Loans Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves information about loan products. ```APIDOC ## Loans Operations ### Description Fetches information about loan products. ### Methods - **fetchLoans()**: GET /loans - **fetchLoan()**: GET /loans/{id} ``` -------------------------------- ### Fetch Models with Filters Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves a paginated list of models, allowing filtering via options. ```APIDOC ## GET /models ### Description Fetches a list of models with optional filters. ### Method GET ### Endpoint /models ### Parameters #### Query Parameters - **itemId** (string) - Required - The ID of the item to filter models by. - **options** (ModelFilters) - Optional - An object containing additional filters for the models. ### Response #### Success Response (200) - **data** (PageResponse) - A paginated response containing a list of Model objects. ``` -------------------------------- ### Create and Fetch Payment Recipient Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Create a payment recipient with PIX or bank account details and then fetch the created recipient using its ID. ```typescript const recipient = await payments.createPaymentRecipient({ // recipient payload (PIX / bank account details, etc.) }) const fetched = await payments.fetchPaymentRecipient(recipient.id) ``` -------------------------------- ### Fetch All Transactions Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Retrieves all transactions for a given item, handling pagination automatically. ```APIDOC ## Fetch All Transactions ### Description Fetches all transactions for a specified item, automatically handling pagination to retrieve all available records. ### Method `client.fetchAllTransactions(options)` ### Parameters #### Request Body - **options** (object) - Required - An object containing: - **itemId** (string) - Required - The ID of the item. - **pageSize** (number) - Optional - The number of transactions to fetch per page. Defaults to a reasonable value if not provided. ``` -------------------------------- ### Create Payment Recipient Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Creates a recipient for payment initiation. ```APIDOC ## Create Payment Recipient ### Description Creates a new recipient for payment initiation, which can include bank account or PIX details. ### Method `payments.createPaymentRecipient(recipientPayload)` ### Parameters #### Request Body - **recipientPayload** (object) - Required - The details of the payment recipient (e.g., PIX or bank account information). ``` -------------------------------- ### Import TypeScript Types Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Import specific types like Item and Transaction directly from the 'pluggy-sdk' package for use in your TypeScript projects. ```typescript import type { Item, Transaction } from 'pluggy-sdk' ``` -------------------------------- ### Fetch Item Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Retrieves details of a specific item by its ID. ```APIDOC ## Fetch Item ### Description Fetches the details of a specific item using its unique ID. ### Method `client.fetchItem(itemId)` ### Parameters #### Path Parameters - **itemId** (string) - Required - The ID of the item to fetch. ``` -------------------------------- ### Create Payment Request Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Create a payment request by providing the necessary payment request payload to the payments client. ```typescript const request = await payments.createPaymentRequest({ // payment request payload }) ``` -------------------------------- ### Fetch Account Statements Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves account statements for a given account. ```APIDOC ## GET /accounts/{id}/statements ### Description Retrieves account statements for a specified account. ### Method GET ### Endpoint /accounts/{id}/statements ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the account. #### Query Parameters - **startDate** (string) - Optional - The start date for the statement period (YYYY-MM-DD). - **endDate** (string) - Optional - The end date for the statement period (YYYY-MM-DD). ``` -------------------------------- ### Error Handling with Try-Catch Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Implement error handling for API calls using a try-catch block. Log any errors encountered during the process. ```typescript try { const item = await client.fetchItem('item_id') console.log(item) } catch (err) { // Surface the error message and/or response details in your app logs console.error(err) } ``` -------------------------------- ### Fetch Accounts Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Retrieves a list of accounts associated with a specific item. ```APIDOC ## Fetch Accounts ### Description Retrieves all accounts linked to a specific item. ### Method `client.fetchAccounts(itemId, options)` ### Parameters #### Path Parameters - **itemId** (string) - Required - The ID of the item whose accounts are to be fetched. #### Query Parameters - **options** (object) - Optional - Filtering and pagination options. ``` -------------------------------- ### Fetch Model by ID Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves a specific model by its unique identifier. ```APIDOC ## GET /models/{id} ### Description Fetches a single model by its ID. ### Method GET ### Endpoint /models/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the model to retrieve. ### Response #### Success Response (200) - **data** (Model) - The requested Model object. ``` -------------------------------- ### Fetch Transactions Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Retrieves a paginated list of transactions for a given item. ```APIDOC ## Fetch Transactions ### Description Fetches a paginated list of transactions for a specified item. ### Method `client.fetchTransactions(options)` ### Parameters #### Request Body - **options** (object) - Required - An object containing: - **itemId** (string) - Required - The ID of the item. - **page** (number) - Optional - The page number to retrieve. - **pageSize** (number) - Optional - The number of transactions per page. ``` -------------------------------- ### Fetch Investment Transactions Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves investment transactions for a specific investment. ```APIDOC ## GET /investments/{id}/transactions ### Description Retrieves investment transactions for a specified investment. ### Method GET ### Endpoint /investments/{id}/transactions ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the investment. #### Query Parameters - **startDate** (string) - Optional - The start date for filtering transactions (YYYY-MM-DD). - **endDate** (string) - Optional - The end date for filtering transactions (YYYY-MM-DD). ``` -------------------------------- ### Smart Accounts Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Manages smart accounts, including creation, retrieval, and balance checks. ```APIDOC ## Smart Accounts Management ### Description Manages smart accounts, which are virtual accounts for enhanced financial management. ### Methods - **createSmartAccount()**: Creates a new smart account. - **fetchSmartAccount()**: Fetches details of a specific smart account. - **fetchSmartAccountBalance()**: Fetches the balance of a smart account. - **fetchSmartAccounts()**: Fetches a list of smart accounts. ``` -------------------------------- ### Webhooks Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Provides full CRUD (Create, Read, Update, Delete) operations for webhooks. ```APIDOC ## Webhooks Operations ### Description Manages webhook subscriptions for receiving real-time event notifications. ### Methods Full CRUD operations are available for the /webhooks endpoint. ``` -------------------------------- ### Bulk Payments Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Provides full CRUD operations for managing bulk payment processes. ```APIDOC ## Bulk Payments Management ### Description Manages operations for processing multiple payments in a single batch. ### Methods Full CRUD operations are available for bulk payments. ``` -------------------------------- ### Consents Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves information about user consents. ```APIDOC ## Consents Operations ### Description Fetches information about user consents granted for data access. ### Methods - **fetchConsents()**: GET /consents - **fetchConsent()**: GET /consents/{id} ``` -------------------------------- ### Items Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Manages financial data items, including creation, retrieval, update, and deletion. ```APIDOC ## Item Operations ### Description Provides methods for managing financial data items, which represent a connection to a financial institution. ### Methods - **createItem()**: POST /items - **fetchItem()**: GET /items/{id} - **updateItem()**: PUT /items/{id} - **deleteItem()**: DELETE /items/{id} ``` -------------------------------- ### Accounts Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves information about financial accounts associated with an item. ```APIDOC ## Accounts Operations ### Description Fetches financial account information linked to a specific item. ### Methods - **fetchAccounts()**: GET /accounts - **fetchAccount()**: GET /accounts/{id} ``` -------------------------------- ### Identity Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves identity information associated with an item or by item ID. ```APIDOC ## Identity Operations ### Description Fetches identity information related to financial accounts. ### Methods - **fetchIdentity()**: GET /identity - **fetchIdentityByItemId()**: GET /identity/{itemId} ``` -------------------------------- ### Automatic PIX Operations Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Provides multiple methods for handling automatic PIX payments. ```APIDOC ## Automatic PIX Operations ### Description Offers various functionalities for automating PIX (Brazilian instant payment system) transactions. ### Methods Multiple methods are available for PIX automático operations. ``` -------------------------------- ### Investments Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves information about investment holdings and transactions. ```APIDOC ## Investments Operations ### Description Fetches investment holdings and associated transactions. ### Methods - **fetchInvestments()**: GET /investments - **fetchInvestment()**: GET /investments/{id} ``` -------------------------------- ### Smart Transfers Operations Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Provides multiple methods for managing smart transfers. ```APIDOC ## Smart Transfers Operations ### Description Manages intelligent fund transfers with advanced features. ### Methods Multiple methods are available for smart transfers. ``` -------------------------------- ### Payment Requests Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Manages payment requests, including creation and retrieval. ```APIDOC ## Payment Requests Management ### Description Manages payment requests, which are instructions to initiate a payment. ### Methods - **createPaymentRequest()**: Creates a new payment request. - **fetchPaymentRequest()**: Fetches a specific payment request. - **fetchPaymentRequests()**: Fetches a list of payment requests. - **deletePaymentRequest()**: Deletes a payment request. ``` -------------------------------- ### Validate Connector Parameters Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Validates the parameters required for a specific connector. ```APIDOC ## POST /connectors/{id}/validate ### Description Validates the parameters required for a specific connector. ### Method POST ### Endpoint /connectors/{id}/validate ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the connector. #### Request Body - **parameters** (object) - Required - An object containing the parameters to validate. ``` -------------------------------- ### Item MFA Update Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Updates an item that requires Multi-Factor Authentication. ```APIDOC ## POST /items/{id}/mfa ### Description Updates an item that requires Multi-Factor Authentication (MFA) to complete the connection process. ### Method POST ### Endpoint /items/{id}/mfa ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the item. #### Request Body - **mfaCode** (string) - Required - The MFA code provided by the user. - **mfaResponse** (string) - Optional - Additional MFA response if required. ``` -------------------------------- ### Payment Intents Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Manages payment intents, representing the intention to make a payment. ```APIDOC ## Payment Intents Management ### Description Manages payment intents, which are objects that represent the intention to pay and track the payment lifecycle. ### Methods - **createPaymentIntent()**: Creates a new payment intent. - **fetchPaymentIntent()**: Fetches a specific payment intent. - **fetchPaymentIntents()**: Fetches a list of payment intents. ``` -------------------------------- ### Transactions Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves and manages financial transactions. ```APIDOC ## Transactions Operations ### Description Provides methods for fetching and managing financial transactions. ### Methods - **fetchTransactions()**: GET /transactions - **fetchTransaction()**: GET /transactions/{id} - **fetchAllTransactions()**: GET /transactions (with pagination parameters) ``` -------------------------------- ### Payment Customers Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Provides full CRUD operations for managing payment customers. ```APIDOC ## Payment Customers Management ### Description Manages customer information relevant to payment processing. ### Methods Full CRUD operations are available for managing payment customers. ``` -------------------------------- ### Categories Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves information about transaction categories. ```APIDOC ## Categories Operations ### Description Fetches information about categories used for classifying transactions. ### Methods - **fetchCategories()**: GET /categories - **fetchCategory()**: GET /categories/{id} ``` -------------------------------- ### Credit Card Bills Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves information about credit card bills. ```APIDOC ## Credit Card Bills Operations ### Description Fetches information about credit card bills. ### Methods - **fetchCreditCardBills()**: GET /bills - **fetchCreditCardBill()**: GET /bills/{id} ``` -------------------------------- ### Payment Institutions Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Retrieves information about payment institutions. ```APIDOC ## Payment Institutions Management ### Description Fetches information about institutions that facilitate payments. ### Methods - **fetchPaymentInstitution()**: Fetches details of a specific payment institution. - **fetchPaymentInstitutions()**: Fetches a list of available payment institutions. ``` -------------------------------- ### Fetch Payment Recipient Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Retrieves details of a specific payment recipient. ```APIDOC ## Fetch Payment Recipient ### Description Fetches the details of a specific payment recipient using their unique ID. ### Method `payments.fetchPaymentRecipient(recipientId)` ### Parameters #### Path Parameters - **recipientId** (string) - Required - The ID of the payment recipient to fetch. ``` -------------------------------- ### Update Item MFA Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Updates an item when Multi-Factor Authentication (MFA) is required. ```APIDOC ## Update Item MFA ### Description Provides the necessary information to complete the Multi-Factor Authentication (MFA) process for an item. ### Method `client.updateItemMFA(itemId, mfaPayload)` ### Parameters #### Path Parameters - **itemId** (string) - Required - The ID of the item requiring MFA. #### Request Body - **mfaPayload** (object) - Required - The MFA payload details provided by Pluggy. ``` -------------------------------- ### Scheduled Payments Operations Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Provides multiple methods for managing scheduled payments. ```APIDOC ## Scheduled Payments Operations ### Description Manages payments that are set to be executed at a future date or time. ### Methods Multiple methods are available for managing scheduled payments. ``` -------------------------------- ### Update Model Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Updates an existing model identified by its ID with the provided payload. ```APIDOC ## PATCH /models/{id} ### Description Updates an existing model. ### Method PATCH ### Endpoint /models/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the model to update. #### Request Body - **payload** (UpdateModelPayload) - Required - The data to update the model with. ### Response #### Success Response (200) - **data** (Model) - The updated Model object. ``` -------------------------------- ### Delete Webhook Source: https://github.com/pluggyai/pluggy-node/blob/master/README.md Removes a registered webhook. ```APIDOC ## Delete Webhook ### Description Deletes a specific webhook registration. ### Method `client.deleteWebhook(webhookId)` ### Parameters #### Path Parameters - **webhookId** (string) - Required - The ID of the webhook to delete. ``` -------------------------------- ### Delete Model Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Deletes a model identified by its ID. ```APIDOC ## DELETE /models/{id} ### Description Deletes a model. ### Method DELETE ### Endpoint /models/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the model to delete. ### Response #### Success Response (200) - **data** (void) - Indicates successful deletion. ``` -------------------------------- ### Payment Recipients Management Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Manages payment recipients for various payment operations. ```APIDOC ## Payment Recipients Management ### Description Provides methods for managing entities that receive payments. ### Methods - **createPaymentRecipient()**: Creates a new payment recipient. - **fetchPaymentRecipient()**: Fetches a specific payment recipient. - **fetchPaymentRecipients()**: Fetches a list of payment recipients. - **updatePaymentRecipient()**: Updates an existing payment recipient. - **deletePaymentRecipient()**: Deletes a payment recipient. ``` -------------------------------- ### Update Transaction Category Source: https://github.com/pluggyai/pluggy-node/blob/master/CLAUDE.md Updates the category of a specific transaction. ```APIDOC ## PATCH /transactions/{id} ### Description Updates the category of a specific transaction. ### Method PATCH ### Endpoint /transactions/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the transaction. #### Request Body - **categoryId** (string) - Required - The ID of the new category for the transaction. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.