Product endpoints
API reference for Plaid products
Transactions
Retrieve and refresh 24 months of historical transaction data, including geolocation, merchant, and category information.
| In this section | |
|---|---|
/transactions/get | Fetch transaction data |
/transactions/refresh | Refresh transaction data |
/categories/get | Fetch all transaction categories |
/transactions/get
/transactions/refresh
/categories/get
Auth
Retrieve 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.
| In this section | |
|---|---|
/auth/get | Fetch account information |
/auth/get
Balance
Verify real-time account balances.
| In this section | |
|---|---|
/accounts/balance/get | Fetch real-time account balances |
/accounts/balance/get
Identity
Verify the name, address, phone number, and email address of a user against bank account information on file.
| In this section | |
|---|---|
/identity/get | Fetch identity data |
/identity/get
Assets
Create, delete, retrieve and share Asset Reports with information about a user's assets and transactions.
| In this section | |
|---|---|
/asset_report/create | Create an Asset Report |
/asset_report/get | Get an Asset Report |
/asset_report/pdf/get | Get a PDF Asset Report |
/asset_report/refresh | Create an updated Asset Report |
/asset_report/filter | Filter unneeded accounts from an Asset Report |
/asset_report/remove | Delete an asset report |
/asset_report/audit_copy/create | Create an Audit Copy of an Asset Report for sharing |
/asset_report/audit_copy/remove | Delete an Audit Copy of an Asset Report |
/asset_report/create
/asset_report/get
/asset_report/pdf/get
Response
This endpoint returns binary PDF data. View a sample Asset Report PDF.
/asset_report/refresh
/asset_report/filter
/asset_report/remove
/asset_report/audit_copy/create
/asset_report/audit_copy/remove
Investments
| In this section | |
|---|---|
/investments/holdings/get | Fetch investment holdings |
/investments/transactions/get | Fetch investment transactions |
/investments/holdings/get
/investments/transactions/get
Liabilities
| In this section | |
|---|---|
/liabilities/get | Fetch liabilities data |
/liabilities/get
Payment Initiation (UK and Europe)
Make payment transfers from your app (currently available for sending payments from accounts within the UK only). Plaid supports both domestic payments denominated in pound sterling (typically via the Faster Payments network) and international payments denominated in euro (typically via SEPA Credit Transfer).
For payment transfers in the US, see Bank Transfers.
| In this section | |
|---|---|
/payment_initiation/recipient/create | Create a recipient |
/payment_initiation/recipient/get | Fetch recipient data |
/payment_initiation/recipient/list | List all recipients |
/payment_initiation/payment/create | Create a payment |
/payment_initiation/payment/get | Fetch a payment |
/payment_initiation/payment/list | List all payments |
/payment_initiation/recipient/create
/payment_initiation/recipient/get
/payment_initiation/recipient/list
/payment_initiation/payment/create
/payment_initiation/payment/get
/payment_initiation/payment/list
Bank Transfers (beta)
Transfer funds between bank accounts in the US.
| In this section | |
|---|---|
/bank_transfer/create | Initiate a bank transfer |
/bank_transfer/cancel | Cancel a bank transfer |
/bank_transfer/get | Retrieve data about a bank transfer |
/bank_transfer/list | Find bank transfers matching specified criteria |
/bank_transfer/event/list | Retrieve bank transfer events matching specified criteria |
/bank_transfer/event/sync | Retrieve bank transfer events after a given bank transfer event |
/bank_transfer/migrate_account | Create an Item to use with Bank Transfers from a known account number and routing number |
/bank_transfer/balance/get | Retrieve the balance on your Plaid bank transfer account |
/bank_transfer/create
/bank_transfer/cancel
/bank_transfer/get
/bank_transfer/list
/bank_transfer/event/list
/bank_transfer/event/sync
/bank_transfer/migrate_account
/bank_transfer/balance/get
Deposit Switch (beta)
Enable users to switch the account they want to receive direct deposits to.
| In this section | |
|---|---|
/deposit_switch/create | Create a deposit switch (for Plaid Exchange customers) |
/deposit_switch/alt/create | Create a deposit switch (for non-Plaid-Exchange customers) |
/deposit_switch/get | Retrieve a deposit switch |
