{"info":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","description":"

The Plaid API enables seamless integration with financial data, allowing developers to connect applications to users' bank accounts, perform transfers, and access account details.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"21079881","collectionId":"73c51b62-5ce6-4d32-936b-427d372586b1","publishedId":"2sAYBUDsK9","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-24T20:48:34.000Z"},"item":[{"name":"Introduction","item":[{"name":"API protocols and headers","item":[],"id":"7efd3bdf-5545-4dd1-8bca-b3228e26303a","description":"

The Plaid API communicates using JSON over HTTP. You send data with POST requests and receive responses in JSON format. If there’s an error, the response body will show an error_code and error_type. It’s best to check these rather than just relying on the HTTP status code. Most responses come in standard JSON, though some may return binary data.

To keep data secure, the API uses HTTPS with TLS 1.2 or higher (older TLS versions aren’t supported). Ensure your client uses an updated root certificate bundle for TLS verification, and avoid using certificate pinning.

When making requests:

Set the Content-Type to application/json.
\n
Make sure the request body is valid JSON.
\n
Include your client_id and secret for authentication as all Plaid API require this.
\n

Every response includes a request_id, which appears in the body or headers (for binary responses, like /asset_report/pdf/get).

\n","_postman_id":"7efd3bdf-5545-4dd1-8bca-b3228e26303a","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"API host","item":[],"id":"1e67fb1f-0ce1-4e7f-aad7-49e8a618c75d","description":"

Plaid has two environments: Sandbox and Production. Items cannot be moved between environments. The Sandbox environment supports only test Items. You can request Production API access via the Dashboard.

https://sandbox.plaid.com (Sandbox)\nhttps://production.plaid.com (Production)\n\n

Always Include your client_id and secret as part of every request for authentication.

\n","_postman_id":"1e67fb1f-0ce1-4e7f-aad7-49e8a618c75d","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Storing API data","item":[],"id":"588f0c4f-d064-43a6-9997-359d8f5e5456","description":"

Any token returned by the API is sensitive and should be stored securely. Except for the public_token and link_token, all Plaid tokens are long-lasting and should never be exposed on the client side. Consumer data obtained from the Plaid API is sensitive information and should be managed accordingly. For guidance and best practices on how to store and handle sensitive data, see the Open Finance Security Data Standard.

Identifiers used by the Plaid API that do not contain consumer data and are not keys or tokens are designed for usage in less sensitive contexts. The most common of these identifiers are the account_id, item_id, link_session_id, and request_id. These identifiers are commonly used for logging and debugging purposes.

\n","_postman_id":"588f0c4f-d064-43a6-9997-359d8f5e5456","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"API field formats","item":[],"id":"22524684-5609-481c-9b61-d48081b67e90","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Type	Description	Notes
String	Many string fields are returned exactly as provided by the financial institution, without maximum length limits or standardized formats.	280 characters is typically adequate for storage, but Plaid does not guarantee this as the maximum.
Numbers and Money	Plaid returns all currency values as decimal values in the currency's standard unit (e.g., dollars) rather than as integers.	Money values can occasionally have more than two decimal places, particularly when reporting values like crypto.

","_postman_id":"22524684-5609-481c-9b61-d48081b67e90","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"OpenAPI definition file","item":[],"id":"da9f4948-0c9d-4567-a5db-7a7cf0dc679b","description":"

OpenAPI is a standard format for describing RESTful APIs that allows those APIs to be integrated with tools for a wide variety of applications, including testing, client library generation, IDE integration, and more. The Plaid API is specified in our Plaid OpenAPI GitHub repo.

\n","_postman_id":"da9f4948-0c9d-4567-a5db-7a7cf0dc679b","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Postman collection","item":[],"id":"57077924-fad6-4f1d-a04d-8c32015dc491","description":"

The Postman collection is a convenient tool for exploring Plaid API endpoints without writing code. The Postman collection provides pre-formatted requests for almost all of Plaid's API endpoints. All you have to do is fill in your API keys and any arguments. To get started, check out the Plaid Postman Collection Quickstart on GitHub.EndFragment

\n","_postman_id":"57077924-fad6-4f1d-a04d-8c32015dc491","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Client libraries","item":[],"id":"cf769996-8b7b-4e38-aad7-288388b34e11","description":"

See the client libraries page for more information on Plaid's client libraries.

\n","_postman_id":"cf769996-8b7b-4e38-aad7-288388b34e11","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}}],"id":"fe5ea355-4cc7-4f1f-9cf0-4fb099f9c89c","description":"

Plaid API provides tools for securely connecting users' bank accounts and financial data to applications. It enables developers to retrieve a wide range of financial information, which can be used in apps for personal finance, banking, lending, investment, and payment services. To integrate the Plaid API endpoints into your projects, you must create an account on the Plaid Dashboard. Once you’ve sucessfully signup, you’ll be provided a live client_id and secret key to access the Plaid API.

\n\n

Create an account with this link.
\n
Click on Sign up.
\n

\n\n

Select one of the three boxes and click on the Continue button.

\n\n

You will be redirected to your Dashboard.

\n\n

Verify your account via the email sent to you.
\n
Click on Developers, from the dropdown click on Keys.
\n

\n\n

Click on the Set up two-factor authentication button to be able to access your client_id and secret.

\n\n

Verify your email by inputting the Verification code sent to your mail.
\n
Click on Set up two authentication factor button.
\n

\n\n

Click on the Authenticator app, scan the QR code, enter your passcode and click register.

\n\n

On the dashboard, click on Keys, and you will see your client_id and secret key in the boxes.

","_postman_id":"fe5ea355-4cc7-4f1f-9cf0-4fb099f9c89c","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Status Code","item":[],"id":"da34bde3-7745-4daf-9b43-02897b7752e1","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status Code	Type	Description
200	OK	The request was successful
404	Transactional Error	When transaction data was updated during pagination
404	Item Errors	The user did not grant necessary permissions for their account
404	Institutional Error	The financial institution indicated that the credentials provided were invalid.
404	Transfer Errors	Attempted transfer exceeded the account's daily transfer or single transfer limits.
404	Income Errors	The requested income verification document was not found.
400	Sandbox Errors	A sandbox operation could not be performed because a product has not been enabled on the Sandbox Item.
500	API Errors	Plaid was unable to process the request
400	Asset Errors	If tems in the Asset Report was not initialized with the Assets product
400	Payment Errors	Errors specific to the Payment Initiation product
400	Virtual Account(UK/EU) Errors	Insufficient funds to complete the transaction.
400	Invalid Request Errors	The request uses fields that are not compatible with the API version being used.
400	ReCAPTCHA Errors	Request was flagged by Plaid's fraud system, and requires additional verification to ensure they are not a bot.
400	OAuth Errors	An incorrect OAuth nonce was supplied when re-initializing Link.
400	Rate Limit Errors	Occurs when the rate limit for a particular endpoint has been exceeded

","_postman_id":"da34bde3-7745-4daf-9b43-02897b7752e1","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Rate Limit","item":[],"id":"aadb6d5b-945d-47d8-8341-5142fc59b5d7","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Endpoint	Max requests per Item	Max requests per client
`/accounts/balance/get`	5 per minute	1,200 per minute
`/accounts/get`	15 per minute	15,000 per minute
`/asset_report/create`	5 per minute	50 per minute
`/asset_report/get`	15 per minute (per asset report)	1,000 per minute
`/asset_report/pdf/get`	15 per minute (per asset report)	50 per minute
`/asset_report/refresh`	5 per minute (per asset report)	50 per minute
`/auth/get`	15 per minute	12,000 per minute
`/identity/get`	15 per minute	2,000 per minute
`/identity_verification/create`	N/A	200 per minute
`/identity_verification/get`	N/A	500 per minute
`/identity_verification/list`	N/A	400 per minute
`/identity_verification/retry`	N/A	200 per minute
`/institutions/get`	N/A	50 per minute
`/institutions/get_by_id`	N/A	400 per minute
`/item/get`	15 per minute	5,000 per minute
`/item/remove`	30 per minute	2,000 per minute
`/signal/evaluate`	70 per hour, 10 per transaction per hour	20 per second
`/signal/decision/report`	N/A	4,000 per minute
`/signal/prepare`	N/A	2,000 per minute
`/signal/return/report`	N/A	4,000 per minute
`/transactions/enrich`	N/A	100 per minute
`/transactions/get`	30 per minute	20,000 per minute
`/transactions/recurring/get`	20 per minute	1,000 per minute
`/transactions/refresh`	2 per minute	100 per minute
`/transactions/sync`	50 per minute	2,500 per minute
`/transfer/authorization/create`	100 per hour	2,500 per minute
`/transfer/cancel`	N/A	250 per minute
`/transfer/create`	N/A	2,500 per minute
`/transfer/event/sync`	N/A	5,000 per minute
`/transfer/intent/create`	N/A	5,000 per minute
`/transfer/migrate_account`	N/A	250 per minute
`/transfer/recurring/cancel`	N/A	250 per minute
`/transfer/recurring/create`	N/A	5,000 per minute
`/transfer/refund/cancel`	N/A	250 per minute
`/transfer/refund/create`	N/A	5,000 per minute
`/payment_initiation/recipient/create`	N/A	240 per minute
`/payment_initiation/recipient/get`	N/A	240 per minute
`/payment_initiation/recipient/list`	N/A	240 per minute
`/payment_initiation/payment/create`	N/A	240 per minute
`/payment_initiation/payment/get`	N/A	240 per minute
`/payment_initiation/payment/list`	N/A	240 per minute
`/payment_initiation/payment/reverse`	N/A	240 per minute
`/payment_initiation/consent/create`	N/A	100 per minute
`/payment_initiation/consent/get`	N/A	240 per minute
`/payment_initiation/consent/revoke`	N/A	100 per minute
`/payment_initiation/consent/payment/execute`	N/A	100 per minute (5 per consent)

","_postman_id":"aadb6d5b-945d-47d8-8341-5142fc59b5d7","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Create public token","item":[{"name":"Create a test Item","id":"fc4a12d2-f3a3-4f4f-83d7-6de4925adf39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"institution_id\": \"ins_127989\",\r\n \"initial_products\": [\"assets\"]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/sandbox/public_token/create","description":"

This endpoint in Plaid is used to generate a public_token for an existing item. The generated public_token is temporary and expires after 30 minutes.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
institutional_id	string	Yes	The ID of the institution the Item will be associated with
initial_products	string	Yes	The products to initially pull for the Item
options	object	No	An optional set of options to be used when configuring the Item

You need to create a valid public_token for an arbitrary institution ID, initial products, and test credentials. After then, you can exchange the public token /item/public_token/exchange for an access_tokenand perform all API actions.

To get your public token:

Go to your Plaid dashboard.

\n\n

Click on Activity.
\n
From the dropdown, click on Status.
\n
Click on Set up two authentication factor button.
\n

\n\n

Enter the Verification code sent to your email.
\n
Click on the Authenticator app, scan the QR code, enter your passcode and click register.
\n

\n\n

You will be redirected to the Status page where you can see all institutions you can use to create your public_token.

","_postman_id":"7b77d6e6-a8c1-4b5f-8af6-61e18d8447a6","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Exchange a public token for an access token","item":[{"name":"Public token for an access token","id":"b3beae0d-fb17-4e4e-ac6d-640315dd6073","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"public_token\": \"{{public_token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/item/public_token/exchange","description":"

This endpoint is used to exchange a public token for a permanent access token. This is used in securely linking a financial institution account to your application.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
public_token	string	Yes	Your public_token, obtained from the /sandbox/item/public_token/create

Exchange a public_token for an API access_token. The public token expires after 30 minutes, while the access_token do not expire. It can only be revoke by calling item/remove. The response also includes an item_id that should be stored with the access_token. The item_id is used to identify an Item in a webhook.

\n","_postman_id":"2495ebc1-996d-4757-a9aa-cc6f86dde658","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Auth","item":[{"name":"Retrieve auth data","id":"1f79969e-1cd8-4b5f-9d42-0decb83c15ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/get","description":"

The /auth/get endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for
options	object	No	An optional object to filter /auth/get results.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"fc99ec76-7d01-49aa-ba81-cd4bc1b14644","id":"fc99ec76-7d01-49aa-ba81-cd4bc1b14644","name":"Auth","type":"folder"}},"urlObject":{"path":["auth","get"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d6736449-cb5f-4042-863a-bf194c6e5aa7","name":"Retrieve auth data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/auth/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Tue, 19 Nov 2024 19:47:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1588"},{"key":"Connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"plaid-version","value":"2020-09-14"},{"key":"vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"}],"cookie":[],"responseTime":null,"body":"{\n \"accounts\": [\n {\n \"account_id\": \"mV4vBqZbqeHVZWZGNp1JC1y1BXQ9aoTg3zwAe\",\n \"balances\": {\n \"available\": 100,\n \"current\": 110,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"0000\",\n \"name\": \"Plaid Checking\",\n \"official_name\": \"Plaid Gold Standard 0% Interest Checking\",\n \"persistent_account_id\": \"8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e\",\n \"subtype\": \"checking\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"ylowZjz5jaUW7K7aG4betxXx5e9lk7C4veLDn\",\n \"balances\": {\n \"available\": 200,\n \"current\": 210,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"1111\",\n \"name\": \"Plaid Saving\",\n \"official_name\": \"Plaid Silver Standard 0.1% Interest Saving\",\n \"persistent_account_id\": \"211a4e5d8361a3afb7a3886362198c7306e00a313b5aa944c20d34b6\",\n \"subtype\": \"savings\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"9nlJgxNKxvHReKevk4xbcmom7e3l4nS4JabEx\",\n \"balances\": {\n \"available\": null,\n \"current\": 1000,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"2222\",\n \"name\": \"Plaid CD\",\n \"official_name\": \"Plaid Bronze Standard 0.2% Interest CD\",\n \"persistent_account_id\": \"2a01484e1b5ef0b54fbcb89658b2764529bbec94a16f7b95481280a7\",\n \"subtype\": \"cd\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"vV1v749A4rHAyWy5mxGMtNkNq9pal7fq7A4XQ\",\n \"balances\": {\n \"available\": null,\n \"current\": 410,\n \"iso_currency_code\": \"USD\",\n \"limit\": 2000,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"3333\",\n \"name\": \"Plaid Credit Card\",\n \"official_name\": \"Plaid Diamond 12.5% APR Interest Credit Card\",\n \"subtype\": \"credit card\",\n \"type\": \"credit\"\n },\n {\n \"account_id\": \"RgEq4rXoreI8pXpvB9njCqVqvxBJQRHa13rGg\",\n \"balances\": {\n \"available\": 43200,\n \"current\": 43200,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"4444\",\n \"name\": \"Plaid Money Market\",\n \"official_name\": \"Plaid Platinum Standard 1.85% Interest Money Market\",\n \"subtype\": \"money market\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"6WVp1zNdzwuXlglmeWMETRjR6GN8Egi8ALMxR\",\n \"balances\": {\n \"available\": null,\n \"current\": 320.76,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"5555\",\n \"name\": \"Plaid IRA\",\n \"official_name\": null,\n \"subtype\": \"ira\",\n \"type\": \"investment\"\n },\n {\n \"account_id\": \"XnmxDaEBaNHV8o8zj9aDCXdXybaBrZiblqzxW\",\n \"balances\": {\n \"available\": null,\n \"current\": 23631.9805,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"6666\",\n \"name\": \"Plaid 401k\",\n \"official_name\": null,\n \"subtype\": \"401k\",\n \"type\": \"investment\"\n },\n {\n \"account_id\": \"DaNJ9MjVMrFXVGV9DqozTP3PJErNyGC3px9Xg\",\n \"balances\": {\n \"available\": null,\n \"current\": 65262,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"7777\",\n \"name\": \"Plaid Student Loan\",\n \"official_name\": null,\n \"subtype\": \"student\",\n \"type\": \"loan\"\n },\n {\n \"account_id\": \"8G5g83Vq3xCZLDLpvb71hy5yGP3rjnuWEj4rn\",\n \"balances\": {\n \"available\": null,\n \"current\": 56302.06,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"8888\",\n \"name\": \"Plaid Mortgage\",\n \"official_name\": null,\n \"subtype\": \"mortgage\",\n \"type\": \"loan\"\n },\n {\n \"account_id\": \"E4PJg1Ev1zUJ767lb3B1tPvP9DMJZWC4dJvEB\",\n \"balances\": {\n \"available\": 6009,\n \"current\": 6009,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"9001\",\n \"name\": \"Plaid HSA\",\n \"official_name\": \"Plaid Cares Health Savings Account\",\n \"subtype\": \"hsa\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"WGb3edgzdoCJ8p8gByZVtbzbgvQEWGt6aKA49\",\n \"balances\": {\n \"available\": 12060,\n \"current\": 12060,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"9002\",\n \"name\": \"Plaid Cash Management\",\n \"official_name\": \"Plaid Growth Cash Management\",\n \"subtype\": \"cash management\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"A3dJvebpelcE5B5VyDxkcZbZ53kBAWF9eEKow\",\n \"balances\": {\n \"available\": 4980,\n \"current\": 5020,\n \"iso_currency_code\": \"USD\",\n \"limit\": 10000,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"9999\",\n \"name\": \"Plaid Business Credit Card\",\n \"official_name\": \"Plaid Platinum Small Business Credit Card\",\n \"subtype\": \"credit card\",\n \"type\": \"credit\"\n }\n ],\n \"item\": {\n \"available_products\": [\n \"assets\",\n \"balance\",\n \"signal\",\n \"identity\",\n \"identity_match\",\n \"income_verification\",\n \"liabilities\",\n \"recurring_transactions\",\n \"statements\",\n \"transactions\",\n \"transactions_refresh\",\n \"transfer\"\n ],\n \"billed_products\": [\n \"auth\"\n ],\n \"consent_expiration_time\": null,\n \"error\": null,\n \"institution_id\": \"ins_127989\",\n \"institution_name\": \"Bank of America\",\n \"item_id\": \"k5dvrGjkGetGdadB93VPta6ernnDw4fWxrxLK\",\n \"products\": [\n \"assets\",\n \"auth\"\n ],\n \"update_type\": \"background\",\n \"webhook\": \"\"\n },\n \"numbers\": {\n \"ach\": [\n {\n \"account\": \"1111222233330000\",\n \"account_id\": \"mV4vBqZbqeHVZWZGNp1JC1y1BXQ9aoTg3zwAe\",\n \"routing\": \"011401533\",\n \"wire_routing\": \"021000021\"\n },\n {\n \"account\": \"1111222233331111\",\n \"account_id\": \"ylowZjz5jaUW7K7aG4betxXx5e9lk7C4veLDn\",\n \"routing\": \"011401533\",\n \"wire_routing\": \"021000021\"\n }\n ],\n \"bacs\": [],\n \"eft\": [],\n \"international\": []\n },\n \"request_id\": \"KUWshs58vg6XgRd\"\n}"}],"_postman_id":"1f79969e-1cd8-4b5f-9d42-0decb83c15ce"},{"name":"List bank transfer events","id":"d13157ff-225f-48b3-8042-93bdd2c189fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"account_id\": \"9nlJgxNKxvHReKevk4xbcmom7e3l4nS4JabEx\",\r\n \"start_date\": \"2024-11-19T14:30:00+01:00\",\r\n \"end_date\": \"2024-11-26T14:30:00+01:00\",\r\n \"bank_transfer_id\": \"460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9\",\r\n \"bank_transfer_type\": \"credit\",\r\n \"event_types\": [\"pending\"],\r\n \"count\": 1,\r\n \"offset\": 0,\r\n \"direction\": \"outbound\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/bank_transfer/event/list","description":"

This endpoint is used to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. This endpoint can be used to fetch status updates on ACH micro-deposits.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
start_date	string	Yes	The start datetime of bank transfers to list.
end_date	string	Yes	The end datetime of bank transfers to list.
bank_transfer_id	string	Yes	Plaid’s unique identifier for a bank transfer.
account_id	string	Yes	The account ID to get events for all transactions to/from an account.
bank_transfer_type	string	Yes	The type of bank transfer. This will be either debit or credit.
event_type	string	Yes	Filter events by event type. Possible values: pending, cancelled, failed, posted, reversed
count	integer	Yes	The maximum number of bank transfer events to return.
offset	integer	Yes	The offset into the list of bank transfer events
direction	string	Yes	Indicates the direction of the transfer: outbound, inbound

This endpoint allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific event_id. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
after_id	integer	Yes	The latest (largest) event_id fetched via the sync endpoint, or 0 initially
count	integer	Yes	The maximum number of bank transfer events to return.

This section is for the API Auth endpoints and webhook. It retrieves bank account information to set up electronic funds transfers, such as ACH payments in the US, EFT payments in Canada, BACS payments in the UK, and IBAN / SIC payments in the EU.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"59ae8409-c1cf-43ae-868d-25ec71fa438f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"921e05a9-6282-4f6c-b2df-769b88fb4137","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"fc99ec76-7d01-49aa-ba81-cd4bc1b14644"},{"name":"Balance","item":[{"name":"Retrieve real-time balance data","id":"1e58ff56-7241-4c75-9610-e20e916fccec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"","value":"","type":"text"}],"body":{"mode":"raw","raw":"\r\n{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/accounts/balance/get","description":"

This endpoint returns the real-time balance for each of an Item's accounts. It can be used for existing Items that were added via any of Plaid’s other products

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for
options	object	No	An optional parameter.

This API reference and verify real-time account balances.

\n","_postman_id":"871b55f0-f2bb-4679-8b8b-a67bbca5a142","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Identity","item":[{"name":"Retrieve identity data","id":"2003188c-d4ea-4afe-85de-d24231478b27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/identity/get ","description":"

This endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for
options	object	No	An optional object to filter.

","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}},"urlObject":{"path":["identity","get "],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"50477cbe-458e-487b-89ff-dbc23b7d1f07","name":"Retrieve identity data","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/identity/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 21 Nov 2024 17:10:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"content-encoding","value":"gzip"},{"key":"plaid-version","value":"2020-09-14"},{"key":"vary","value":"Accept-Encoding"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains; preload"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-XSS-Protection","value":"1; mode=block"}],"cookie":[],"responseTime":null,"body":"{\n \"accounts\": [\n {\n \"account_id\": \"mV4vBqZbqeHVZWZGNp1JC1y1BXQ9aoTg3zwAe\",\n \"balances\": {\n \"available\": 100,\n \"current\": 110,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"0000\",\n \"name\": \"Plaid Checking\",\n \"official_name\": \"Plaid Gold Standard 0% Interest Checking\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"persistent_account_id\": \"8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e\",\n \"subtype\": \"checking\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"ylowZjz5jaUW7K7aG4betxXx5e9lk7C4veLDn\",\n \"balances\": {\n \"available\": 200,\n \"current\": 210,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"1111\",\n \"name\": \"Plaid Saving\",\n \"official_name\": \"Plaid Silver Standard 0.1% Interest Saving\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"persistent_account_id\": \"211a4e5d8361a3afb7a3886362198c7306e00a313b5aa944c20d34b6\",\n \"subtype\": \"savings\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"9nlJgxNKxvHReKevk4xbcmom7e3l4nS4JabEx\",\n \"balances\": {\n \"available\": null,\n \"current\": 1000,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"2222\",\n \"name\": \"Plaid CD\",\n \"official_name\": \"Plaid Bronze Standard 0.2% Interest CD\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"persistent_account_id\": \"2a01484e1b5ef0b54fbcb89658b2764529bbec94a16f7b95481280a7\",\n \"subtype\": \"cd\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"vV1v749A4rHAyWy5mxGMtNkNq9pal7fq7A4XQ\",\n \"balances\": {\n \"available\": null,\n \"current\": 410,\n \"iso_currency_code\": \"USD\",\n \"limit\": 2000,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"3333\",\n \"name\": \"Plaid Credit Card\",\n \"official_name\": \"Plaid Diamond 12.5% APR Interest Credit Card\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"credit card\",\n \"type\": \"credit\"\n },\n {\n \"account_id\": \"RgEq4rXoreI8pXpvB9njCqVqvxBJQRHa13rGg\",\n \"balances\": {\n \"available\": 43200,\n \"current\": 43200,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"4444\",\n \"name\": \"Plaid Money Market\",\n \"official_name\": \"Plaid Platinum Standard 1.85% Interest Money Market\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"money market\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"6WVp1zNdzwuXlglmeWMETRjR6GN8Egi8ALMxR\",\n \"balances\": {\n \"available\": null,\n \"current\": 320.76,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"5555\",\n \"name\": \"Plaid IRA\",\n \"official_name\": null,\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"ira\",\n \"type\": \"investment\"\n },\n {\n \"account_id\": \"XnmxDaEBaNHV8o8zj9aDCXdXybaBrZiblqzxW\",\n \"balances\": {\n \"available\": null,\n \"current\": 23631.9805,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"6666\",\n \"name\": \"Plaid 401k\",\n \"official_name\": null,\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"401k\",\n \"type\": \"investment\"\n },\n {\n \"account_id\": \"DaNJ9MjVMrFXVGV9DqozTP3PJErNyGC3px9Xg\",\n \"balances\": {\n \"available\": null,\n \"current\": 65262,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"7777\",\n \"name\": \"Plaid Student Loan\",\n \"official_name\": null,\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"student\",\n \"type\": \"loan\"\n },\n {\n \"account_id\": \"8G5g83Vq3xCZLDLpvb71hy5yGP3rjnuWEj4rn\",\n \"balances\": {\n \"available\": null,\n \"current\": 56302.06,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"8888\",\n \"name\": \"Plaid Mortgage\",\n \"official_name\": null,\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"mortgage\",\n \"type\": \"loan\"\n },\n {\n \"account_id\": \"E4PJg1Ev1zUJ767lb3B1tPvP9DMJZWC4dJvEB\",\n \"balances\": {\n \"available\": 6009,\n \"current\": 6009,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"9001\",\n \"name\": \"Plaid HSA\",\n \"official_name\": \"Plaid Cares Health Savings Account\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"hsa\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"WGb3edgzdoCJ8p8gByZVtbzbgvQEWGt6aKA49\",\n \"balances\": {\n \"available\": 12060,\n \"current\": 12060,\n \"iso_currency_code\": \"USD\",\n \"limit\": null,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"9002\",\n \"name\": \"Plaid Cash Management\",\n \"official_name\": \"Plaid Growth Cash Management\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"cash management\",\n \"type\": \"depository\"\n },\n {\n \"account_id\": \"A3dJvebpelcE5B5VyDxkcZbZ53kBAWF9eEKow\",\n \"balances\": {\n \"available\": 4980,\n \"current\": 5020,\n \"iso_currency_code\": \"USD\",\n \"limit\": 10000,\n \"unofficial_currency_code\": null\n },\n \"mask\": \"9999\",\n \"name\": \"Plaid Business Credit Card\",\n \"official_name\": \"Plaid Platinum Small Business Credit Card\",\n \"owners\": [\n {\n \"addresses\": [\n {\n \"data\": {\n \"city\": \"Malakoff\",\n \"country\": \"US\",\n \"postal_code\": \"14236\",\n \"region\": \"NY\",\n \"street\": \"2992 Cameron Road\"\n },\n \"primary\": true\n },\n {\n \"data\": {\n \"city\": \"San Matias\",\n \"country\": \"US\",\n \"postal_code\": \"93405-2255\",\n \"region\": \"CA\",\n \"street\": \"2493 Leisure Lane\"\n },\n \"primary\": false\n }\n ],\n \"emails\": [\n {\n \"data\": \"accountholder0@example.com\",\n \"primary\": true,\n \"type\": \"primary\"\n },\n {\n \"data\": \"accountholder1@example.com\",\n \"primary\": false,\n \"type\": \"secondary\"\n },\n {\n \"data\": \"extraordinarily.long.email.username.123456@reallylonghostname.com\",\n \"primary\": false,\n \"type\": \"other\"\n }\n ],\n \"names\": [\n \"Alberta Bobbeth Charleson\"\n ],\n \"phone_numbers\": [\n {\n \"data\": \"1112223333\",\n \"primary\": false,\n \"type\": \"home\"\n },\n {\n \"data\": \"1112224444\",\n \"primary\": false,\n \"type\": \"work\"\n },\n {\n \"data\": \"1112225555\",\n \"primary\": false,\n \"type\": \"mobile\"\n }\n ]\n }\n ],\n \"subtype\": \"credit card\",\n \"type\": \"credit\"\n }\n ],\n \"item\": {\n \"available_products\": [\n \"assets\",\n \"balance\",\n \"signal\",\n \"identity_match\",\n \"income_verification\",\n \"liabilities\",\n \"recurring_transactions\",\n \"statements\",\n \"transactions\",\n \"transactions_refresh\",\n \"transfer\"\n ],\n \"billed_products\": [\n \"auth\",\n \"identity\"\n ],\n \"consent_expiration_time\": null,\n \"error\": null,\n \"institution_id\": \"ins_127989\",\n \"institution_name\": \"Bank of America\",\n \"item_id\": \"k5dvrGjkGetGdadB93VPta6ernnDw4fWxrxLK\",\n \"products\": [\n \"assets\",\n \"auth\",\n \"identity\"\n ],\n \"update_type\": \"background\",\n \"webhook\": \"\"\n },\n \"request_id\": \"qqyzfKXGNTLa5Tk\"\n}"}],"_postman_id":"2003188c-d4ea-4afe-85de-d24231478b27"},{"name":"Retrieve identity match score","id":"3e9aa5b3-102e-43c8-bf7a-cd30f4765243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\",\r\n \"user\": {\r\n \"phone_number\": \"12345678\",\r\n \"legal_name\": \"John Doe\",\r\n \"email_address\": \"johndoe@yahoo.com\",\r\n \"address\": {\r\n \"street\": \"John street\",\r\n \"region\": \"Texas\",\r\n \"country\": \"USA\",\r\n \"city\": \"Houston\",\r\n \"postal_code\": \"112345\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/identity/match","description":"

This 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.

StartFragment

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for
user	object	No	The user's legal name, phone number, email address and address used to perform fuzzy match

This endpoint retrieve identity details when using Identity Document Upload.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for
options	object	No	An optional object to filter

This API verify the name, address, phone number, and email address of a user against bank account information on file.

\n","_postman_id":"796ba1ec-f599-489c-9d78-6f97f9343031","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Signal","item":[{"name":"Evaluate a planned ACH transaction","id":"9c67dc23-c84c-4b93-b0d5-df672501912c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\",\r\n \"account_id\": \"ylowZjz5jaUW7K7aG4betxXx5e9lk7C4veLDn\",\r\n \"client_transaction_id\": \"txn12345\",\r\n \"amount\": 543.45,\r\n \"client_user_id\": \"user1234\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/signal/evaluate","description":"

This endpoint evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. In order to obtain a valid score for an This endpoint evaluate ACH transaction, Plaid must have an access token for the account, and the Item must be healthy or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The Plaid access_token for the account that will be debited or credited.
account_id	string	Yes	The Plaid account_id corresponding to the end-user account that will be debited or credited.
client_transactional_id	string	Yes	The unique ID that you would like to use to refer to this transaction
amount	number	Yes	The transaction amount, in USD (e.g. 102.05)
user_present	boolean	No	true if the end user is present while initiating the ACH transfer and the endpoint is being called; false otherwise
client_user_id	string	No	A unique ID that identifies the end user in your system

This endpoint is used after /signal/evaluate, to report whether the transaction was initiated.

Note: Must be the same as the client_transaction_id supplied when calling /signal/evaluate.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
client_transactional_id	string	Yes	Must be the same as the client_transaction_id supplied when calling /signal/evaluate
initiated	boolean	Yes	true if the ACH transaction was initiated, false otherwise

This endpoint to report a returned transaction that was previously sent to the /signal/evaluate endpoint.

Note: Must be the same as the client_transaction_id supplied when calling /signal/evaluate or /accounts/balance/get.

Must be a valid ACH return code (e.g. \"R01\")

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
client_transactional_id	string	Yes	Must be the same as the client_transaction_id supplied when calling /signal/evaluate
return_code	string	Yes	Must be a valid ACH return code (e.g. \"R01\")

This enpoint is used when an Item is not initialized with Signal, call /signal/prepare to opt-in that Item to the Signal data collection process, developing a Signal score.

If /signal/prepare is skipped on an Item that is not initialized with Signal, the initial call to /signal/evaluate on that Item will be less accurate, because Signal will have access to less data for computing the Signal score.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for

The Signal endpoint in Plaid API is used to evaluate the risk of a bank transfer transaction and help detect potentially fraudulent activity. It provides real-time insights and predictive risk scores to assist in decision-making for ACH transactions.

\n","_postman_id":"6e933b1f-2327-4ed5-9ba9-1ae047e7a0f2","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Transfer","item":[{"name":"Initaiting Transfer","item":[{"name":"Create a transfer authorization","id":"b2382570-cad3-4417-adf5-a879f0c3e7c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\",\r\n \"account_id\": \"ylowZjz5jaUW7K7aG4betxXx5e9lk7C4veLDn\",\r\n \"type\": \"debit\",\r\n \"network\": \"ach\",\r\n \"amount\": \"30.54\",\r\n \"ach_class\": \"ppd\",\r\n \"user\": {\r\n \"legal_name\": \"John Doe\"\r\n }\r\n\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transfer/authorization/create","description":"

This endpoint is used to authorize a transfer. This endpoint must be called prior to calling /transfer/create. The transfer authorization will expire if not used after one hour.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for
account_id	string	Yes	The Plaid account_id corresponding to the end-user account that will be debited or credited
type	string	Yes	The type of transfer. This will be either debit or credit.
network	string	Yes	The network or rails used for the transfer.
amount	string	Yes	The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\")
ach_class	string	Yes	Specifies the use case of the transfer.
user	string	Yes	The legal name and other information for the account holder

This endpoint is used to cancel a transfer authorization. A transfer authorization is eligible for cancellation if it has not yet been used to create a transfer.

NOTE: Your authorization_id is the id gotten from your create a transfer authorization response.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
authorization_id	string	Yes	Plaid’s unique identifier for a transfer authorization.

This endpoint is used to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided transfer_id has already been created, it will return the transfer details without creating a new transfer.

StartFragment

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The Plaid access_token for the account that will be debited or credited.
account_id	string	Yes	The Plaid account_id corresponding to the end-user account that will be debited or credited.
authorization_id	string	Yes	Plaid’s unique identifier for a transfer authorization
amount	string	No	The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\")
description	string	Yes	The transfer description

This endpoint is used to cancel a transfer. A transfer is eligible for cancellation if the cancellable property returned by /transfer/get is true.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
transfer_id	string	Yes	Plaid’s unique identifier for a transfer.

The Transfer Endpoint in Plaid API facilitates the creation, management, and monitoring of bank-to-bank transfers. It supports the full transfer lifecycle.

\n","_postman_id":"67efe163-82b3-4bd0-8a93-a91369667a33","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Reading Transfer","item":[{"name":"Retrieve a transfer","id":"3f4b444c-720b-4b7b-87b8-89387a9fdf11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"transfer_id\": \"9381512d-d175-e381-a79f-c9a02da4e3cc\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transfer/get","description":"

This endpoint fetches information about the transfer corresponding to the given transfer_id or authorization_id. One of transfer_id or authorization_id must be populated but not both.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
transfer_id	string	Yes	Plaid’s unique identifier for a transfer.
authorization_id	string	No	Plaid’s unique identifier for a transfer authorization.

This endpoint is used to see a list of all your transfers and their statuses. Results are paginated; use the count and offset query parameters to retrieve the desired transfers.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
start_date	string	Yes	The start datetime of transfers to list.
end_date	string	Yes	The end datetime of transfers to list
count	integer	Yes	The maximum number of transfers to return
offset	integer	Yes	The number of transfers to skip before returning results.
originator_account_id	string	Yes	Filter transfers to only those with the specified originator client.

This endpoint is used to get a list of transfer events based on specified filter criteria.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
start_date	string	Yes	The start datetime of transfers to list.
end_date	string	Yes	The end datetime of transfers to list
transfer_id	string	Yes	Plaid’s unique identifier for a transfer.
account_id	string	Yes	The account ID to get events for all transactions to/from an account
transfer_type	string	Yes	The type of transfer. This will be either debit or credit
event_type	string	Yes	Filter events by event type. Possible values: pending, cancelled, failed, posted, settled
count	integer	Yes	The maximum number of transfers to return
offset	integer	Yes	The number of transfers to skip before returning results.
originator_account_id	string	Yes	Filter transfer events to only those with the specified originator client

This endpoint allows you to request up to the next 25 transfer events that happened after a specific event_id. Use the /transfer/event/sync endpoint to guarantee you have seen all transfer events.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
after_id	integer	Yes	The latest (largest) event_id fetched via the sync endpoint, or 0 initially
count	integer	Yes	The maximum number of transfer events to return

This endpoint fetches sweeps matching the given filters.

StartFragment

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
start_date	string	Yes	The start datetime of sweeps to return (RFC 3339 format)
end_date	string	Yes	The end datetime of sweeps to return (RFC 3339 format)
count	integer	Yes	The maximum number of transfer events to return
offset	integer	Yes	The number of sweeps to skip before returning results.

This endpoint is used to determine the RTP eligibility information of an account to be used with Transfer. This endpoint works on all Transfer-capable Items, including those created by /transfer/migrate_account.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The Plaid access_token for the account that will be debited or credited.
account_id	string	Yes	The Plaid account_id corresponding to the end-user account that will be debited or credited.

This endpoint is used to generate a transfer intent object and invoke the Transfer UI.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
account_id	string	Yes	The Plaid account_id corresponding to the end-user account that
mode	string	Yes	The direction of the flow of transfer funds
amount	string	Yes	The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\")
ach_class	string	Yes	Specifies the use case of the transfer. Required for transfers on an ACH network
Description	string	Yes	A description for the underlying transfer. Maximum of 15, Minimun 0 characters.
User	object	Yes	The legal name and other information for the account holder.

This endpoint retrieves more information about a transfer intent.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
transfer_intent_id	string	Yes	Plaid's unique identifier for a transfer intent object.

This endpoint is used to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide wire_routing_number.

NOTE: You can get routing numbers in Plaid's sandbox environment which can use for testing.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
account_number	string	Yes	The user's account number.
routing_number	string	Yes	The user's routing number.
wire_routing_number	string	Yes	The type of the bank account (checking or savings).
account_type	string	Yes	The type of the bank account (checking or savings).

API reference for Transfer account linking endpoints

\n","_postman_id":"186fce28-af3c-4801-a5a0-11d79953ef9a","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}},{"name":"Recurring Transfer","item":[{"name":"Create a recurring transfer","id":"5a0198b4-3204-484f-b684-c79c80cd755e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"client_id\": \"{{client_id}}\",\r\n \"secret\": \"{{your_secret}}\",\r\n \"access_token\": \"{{access_token}}\",\r\n \"account_id\": \"ylowZjz5jaUW7K7aG4betxXx5e9lk7C4veLDn\" ,\r\n \"type\": \"credit\",\r\n \"network\": \"ach\",\r\n \"amount\": \"12.34\",\r\n \"ach_class\": \"ppd\",\r\n \"idempotency_key\": \"12345\",\r\n \"description\": \"payment\",\r\n \"schedule\": {\r\n \"start_date\": \"2024-11-25\",\r\n \"end_date\": \"2024-11-30\",\r\n \"interval_unit\": \"week\",\r\n \"interval_count\": 1,\r\n \"interval_execution_day\": 5\r\n },\r\n \"user\": {\r\n \"legal_name\": \"Anne Charleston\",\r\n \"email_address\": \"acharleston@email.com\",\r\n \"phone_number\": \"510-555-0128\"\r\n}\r\n\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/transfer/recurring/create","description":"

This endpoint is used to initiate a new recurring transfer.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
access_token	string	Yes	The access token associated with the Item data is being requested for
idempotency_key	string	Yes	A random key provided by the client, per unique recurring transfer. Maximum of 50 characters.
account_id	string	Yes	The Plaid account_id corresponding to the end-user account that will be debited or credited
type	string	Yes	The type of transfer. This will be either debit or credit.
network	string	Yes	The network or rails used for the transfer.
amount	string	Yes	The amount of the transfer (decimal string with two digits of precision e.g. \"10.00\")
ach_class	string	Yes	Specifies the use case of the transfer.
description	string	Yes	The description of the recurring transfer.
user_present	bolean	No	If the end user is initiating the specific transfer themselves via an interactive UI, this should be true; for automatic recurring payments where the end user is not actually initiating each individual transfer, it should be false.
schedule	object	Yes	The schedule that the recurring transfer will be executed on. View object…
test_clock_id	string	No	Plaid’s unique identifier for a test clock
user	string	Yes	The legal name and other information for the account holder

This endpoint is used to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
recurring_transfer_id	string	Yes	Plaid’s unique identifier for a recurring transfer.

This endpoint fetches information about the recurring transfer corresponding to the given recurring_transfer_id.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
recurring_transfer_id	string	Yes	Plaid’s unique identifier for a recurring transfer.

This endpoint to see a list of all your recurring transfers and their statuses.

Request fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Required	Description
client_id	string	Yes	Your Plaid API client_id
secret	string	Yes	Your Plaid API secret
start_time	string	Yes	The start datetime of recurring transfer (RFC 3339 format)
end_time	string	Yes	The end datetime of recurring transfer (RFC 3339 format)
count	integer	Yes	The maximum number of recurring transfers to return.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key Terms	Definition
API	Application Programming Interface
ID	Identifier
HTTP	HyperText Transfer Protocol
HTTPS	HyperText Transfer Protocol Secure
TLS	Transport Layer Security
ACH	Automated Clearing House
EFT	Electronic Funds Transfer
BACS	Bankers' Automated Clearing Services
IBAN	International Bank Account Number
SIC	Swiss Interbank Clearing
ISO	International Organization for Standardization
RFC	Request for Comments
MFA	Multi-Factor Authentication

","_postman_id":"8fc67726-026f-4cac-bc5a-11b25de32c98","auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"},"isInherited":true,"source":{"_postman_id":"73c51b62-5ce6-4d32-936b-427d372586b1","id":"73c51b62-5ce6-4d32-936b-427d372586b1","name":"PLAID API DOCUMENTATION","type":"collection"}}}],"auth":{"type":"basic","basic":{"password":"{{your_secret}}","username":"{{client_id}}"}},"event":[{"listen":"prerequest","script":{"id":"cc33e325-3300-4bab-917f-1c2554981a1a","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"1d855893-4f5a-4d84-ad4c-eda0204f4f08","type":"text/javascript","packages":{},"exec":[""]}}]}

When making requests:

To signup on the Plaid, follow these steps:

Request fields

To get your public token:

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields

Request fields