{
  "opencollection": "1.0.0",
  "info": {
    "name": "Plaid processor/",
    "version": "2020-09-14_1.517.0"
  },
  "items": [
    {
      "info": {
        "name": "Plaid",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Plaid Retrieve Auth data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/auth/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available.\n\nVersioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/ve"
        },
        {
          "info": {
            "name": "Plaid Retrieve the account associated with a processor token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/account/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint returns the account associated with a given processor token.\n\nThis endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use `/processor/balance/get` instead. Note that some information is nullable.\n"
        },
        {
          "info": {
            "name": "Plaid Get transaction data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/transactions/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta informati"
        },
        {
          "info": {
            "name": "Plaid Get incremental transaction updates on a processor token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/transactions/sync",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases.\n\nThe `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactio"
        },
        {
          "info": {
            "name": "Plaid Refresh transaction data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/transactions/refresh",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "`/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transaction"
        },
        {
          "info": {
            "name": "Plaid Fetch recurring transaction streams",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/transactions/recurring/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and sta"
        },
        {
          "info": {
            "name": "Plaid Evaluate a planned ACH transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/signal/evaluate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals.\n\nIn order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the unde"
        },
        {
          "info": {
            "name": "Plaid Report whether you initiated an ACH transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/signal/decision/report",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated.\n\nIf you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated."
        },
        {
          "info": {
            "name": "Plaid Report a return for an ACH transaction",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/signal/return/report",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.\n\nIf you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned."
        },
        {
          "info": {
            "name": "Plaid Opt-in a processor token to Signal",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/signal/prepare",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "When a processor token is not initialized with Signal, call `/processor/signal/prepare` to opt-in that processor token to the Signal data collection process, which will improve the accuracy of the Signal score.\n\nIf this endpoint is called with a processor token that is already initialized with Signal, it will return a 200 response and will not modify the processor token."
        },
        {
          "info": {
            "name": "Plaid Create a bank transfer as a processor",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/bank_transfer/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor"
        },
        {
          "info": {
            "name": "Plaid Retrieve Liabilities data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/liabilities/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The `/processor/liabilities/get` endpoint returns various details about a loan or credit account. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`.\n\nThe types of information returned by Liabilities can include balances and due dates, loan terms, an"
        },
        {
          "info": {
            "name": "Plaid Retrieve Identity data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/identity/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses."
        },
        {
          "info": {
            "name": "Plaid Retrieve identity match score",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/identity/match",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution.\n\nFields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.\n\nThis request may take some time to complete if Identity was not specifi"
        },
        {
          "info": {
            "name": "Plaid Retrieve Balance data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/balance/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached. "
        },
        {
          "info": {
            "name": "Plaid Create processor token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/token/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor tok"
        },
        {
          "info": {
            "name": "Plaid Control a processor's access to products",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/token/permissions/set",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change."
        },
        {
          "info": {
            "name": "Plaid Get a processor token's product permissions",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/token/permissions/get",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products."
        },
        {
          "info": {
            "name": "Plaid Update a processor token's webhook URL",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/token/webhook/update",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL."
        },
        {
          "info": {
            "name": "Plaid Create Stripe bank account token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/stripe/bank_account_token/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "\nUsed to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/).\n\nNote that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank "
        },
        {
          "info": {
            "name": "Plaid Create Apex bank account token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://production.plaid.com/processor/apex/processor_token/create",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations."
        }
      ]
    }
  ],
  "bundled": true
}