Skip to content

Instantly share code, notes, and snippets.

@MarwanRefaat

MarwanRefaat/Suggestions-for-Plaid-OpenAPI-Specification.yaml

Last active December 10, 2021 01:24
Show Gist options
  • Save MarwanRefaat/e64fdc1522d707755ca06bc3385d7ea8 to your computer and use it in GitHub Desktop.
Save MarwanRefaat/e64fdc1522d707755ca06bc3385d7ea8 to your computer and use it in GitHub Desktop.
Download ZIP
Linting suggestions and proposed solutions to warnings/errors returned by Spectral running on the Plaid OpenAPI Specification
Raw
Suggestions-for-Plaid-OpenAPI-Specification.yaml
# OFFICIAL PLAID OPENAPI SPECIFICATION UP TO DATE AS OF DECEMBER 9TH 2021 (SEMVER 1.58.1) WITH MODIFICATIONS AND POTENTIAL SOLUTIONS TO RESOLVE THE WARNINGS AND ERRORS FLAGGED BY SPECTRAL (OPEN-SOURCE JSON/YAML LINTER)
openapi: 3.0.0
servers:
- description: Production
url: 'https://production.plaid.com'
- description: Development
url: 'https://development.plaid.com'
- description: Sandbox
url: 'https://sandbox.plaid.com'
info:
title: The Plaid API
version: 2020-09-14_1.58.1
description: 'The Plaid REST API. Please see https://plaid.com/docs/api for more details.'
contact:
name: Plaid Developer Team
url: 'https://plaid.com'
termsOfService: 'https://plaid.com/legal/'
tags:
- name: plaid
description: The Plaid API
security:
- clientId: []
secret: []
plaidVersion: []
paths:
/item/application/list:
post:
tags:
- plaid
summary: List a user’s connected applications
operationId: itemApplicationList
description: List a user’s connected applications
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationListResponse'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationListRequest'
/item/application/scopes/update:
post:
tags:
- plaid
summary: Update the scopes of access for a particular application
operationId: itemApplicationScopesUpdate
description: Enable consumers to update product access on selected accounts for an application.
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationScopesUpdateResponse'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemApplicationScopesUpdateRequest'
/application/get:
post:
tags:
- plaid
summary: Retrieve information about a Plaid application
operationId: applicationGet
description: Allows financial institutions to retrieve information about Plaid clients for the purpose of building control-tower experiences
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetResponse'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetRequest'
description: ''
/item/get:
post:
tags:
- plaid
summary: Retrieve an Item
externalDocs:
url: /api/items/#itemget
operationId: itemGet
description: Returns information about the status of an Item.
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemGetResponse'
x-examples:
example-1:
value:
item:
available_products:
- balance
- auth
billed_products:
- identity
- transactions
error: null
institution_id: ins_109508
item_id: Ed6bjNrDLJfGvZWwnkQlfxwoNz54B5C97ejBr
update_type: background
webhook: 'https://plaid.com/example/hook'
consent_expiration_time: null
status:
transactions:
last_successful_update: '2019-02-15T15:52:39Z'
last_failed_update: '2019-01-22T04:32:00Z'
last_webhook:
sent_at: '2019-02-15T15:53:00Z'
code_sent: DEFAULT_UPDATE
request_id: m8MDnv9okwxFNBV
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemGetRequest'
description: ''
/auth/get:
post:
tags:
- plaid
summary: Retrieve auth data
externalDocs:
url: /api/products/#authget
operationId: authGet
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.
Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthGetResponse'
examples:
example-1:
value:
accounts:
- account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
balances:
available: 100
current: 110
limit: null
iso_currency_code: USD
unofficial_currency_code: null
mask: '9606'
name: Plaid Checking
official_name: Plaid Gold Checking
subtype: checking
type: depository
numbers:
ach:
- account: '9900009606'
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
routing: '011401533'
wire_routing: '021000021'
eft:
- account: '111122223333'
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
institution: '021'
branch: '01140'
international:
- account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
bic: NWBKGB21
iban: GB29NWBK60161331926819
bacs:
- account: '31926819'
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
sort_code: '601613'
item:
available_products:
- balance
- identity
- payment_initiation
- transactions
billed_products:
- assets
- auth
consent_expiration_time: null
error: null
institution_id: ins_117650
item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
request_id: m8MDnv9okwxFNBV
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Default error
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AuthGetRequest'
examples: {}
description: ''
/transactions/get:
post:
tags:
- plaid
summary: Get transaction data
externalDocs:
url: /api/products/#transactionsget
operationId: transactionsGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsGetResponse'
x-examples:
example-1:
value:
accounts:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
balances:
available: 110
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
transactions:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
amount: 2307.21
iso_currency_code: USD
unofficial_currency_code: null
category:
- Shops
- Computers and Electronics
category_id: '19013000'
check_number: null
date: '2017-01-29'
datetime: null
authorized_date: '2017-01-27'
authorized_datetime: null
location:
address: 300 Post St
city: San Francisco
region: CA
postal_code: '94108'
country: US
lat: 40.740352
lon: -74.001761
store_number: '1235'
name: Apple Store
merchant_name: Apple
payment_meta:
by_order_of: null
payee: null
payer: null
payment_method: null
payment_processor: null
ppd_id: null
reason: null
reference_number: null
payment_channel: in store
pending: false
pending_transaction_id: null
account_owner: null
transaction_id: lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje
transaction_code: null
transaction_type: place
item:
available_products:
- balance
- identity
- investments
billed_products:
- assets
- auth
- liabilities
- transactions
consent_expiration_time: null
error: null
institution_id: ins_3
item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
total_transactions: 1
request_id: 45QSn
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
The `/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). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. 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 information where available.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions).
Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions.
Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint.
Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsGetRequest'
examples: {}
/transactions/refresh:
post:
tags:
- plaid
summary: Refresh transaction data
externalDocs:
url: /api/products/#transactionsrefresh
operationId: transactionsRefresh
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsRefreshResponse'
examples:
example-1:
value:
request_id: 1vwmF5TBQwiqfwP
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
`/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`.
Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsRefreshRequest'
/transactions/recurring/get:
post:
tags:
- plaid
summary: Get streams of recurring transactions
operationId: transactionsRecurringGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsRecurringGetResponse'
examples: {}
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
The `/transactions/recurring/get` endpoint identifies and returns groups of transactions that occur on a regular basis for the inputted Item and accounts.
The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsRecurringGetRequest'
examples: {}
/transactions/sync:
post:
tags:
- plaid
summary: Get incremental transaction updates on an item
externalDocs:
url: /api/products/#transactionssync
operationId: transactionsSync
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsSyncResponse'
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
The `/transactions/sync` endpoint returns item transactions as a set of delta updates.
Subsequent calls to the endpoint using the cursor returned in the response will return new added, modified, and removed transactions since the last call to the endpoint
The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionsSyncRequest'
examples: {}
/institutions/get:
post:
tags:
- plaid
summary: Get details of all supported institutions
externalDocs:
url: /api/institutions/#institutionsget
operationId: institutionsGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetResponse'
examples:
example-1:
value:
institutions:
- country_codes:
- US
institution_id: ins_1
name: Bank of America
oauth: false
products:
- assets
- auth
- balance
- transactions
- identity
- liabilities
routing_numbers:
- '011000138'
- '011200365'
- '011400495'
- '011500010'
- '011900254'
- '021000322'
- '021200339'
- '026009593'
- '031202084'
- '051000017'
- '052001633'
- '053000196'
- '053904483'
- '054001204'
- '061000052'
- '063100277'
- '064000020'
- '071214579'
- '072000805'
- '073000176'
- '081000032'
- '081904808'
- '082000073'
- '101100045'
- '103000017'
- '107000327'
- '111000025'
- '121000358'
- '122101706'
- '122400724'
- '123103716'
- '125000024'
- '323070380'
request_id: tbFyCEqkU774ZGG
total: 11384
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |-
Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated.
If there is no overlap between an institution’s enabled products and a client’s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetRequest'
description: ''
/institutions/search:
post:
tags:
- plaid
summary: Search institutions
externalDocs:
url: /api/institutions/#institutionssearch
operationId: institutionsSearch
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsSearchResponse'
examples:
example-1:
value:
institutions:
- country_codes:
- US
institution_id: ins_118923
name: Red Platypus Bank - Red Platypus Bank
oauth: false
products:
- assets
- auth
- balance
- transactions
- identity
routing_numbers: []
request_id: Ggmk0enW4smO2Tp
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |
Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsSearchRequest'
/institutions/get_by_id:
post:
tags:
- plaid
summary: Get details of an institution
externalDocs:
url: /api/institutions/#institutionsget_by_id
operationId: institutionsGetById
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetByIdResponse'
examples:
example-1:
value:
institution:
country_codes:
- US
institution_id: ins_109512
name: Houndstooth Bank
products:
- auth
- balance
- identity
- transactions
routing_numbers:
- '110000000'
oauth: false
status:
item_logins:
status: HEALTHY
last_status_change: '2019-02-15T15:53:00Z'
breakdown:
success: 0.9
error_plaid: 0.01
error_institution: 0.09
transactions_updates:
status: HEALTHY
last_status_change: '2019-02-12T08:22:00Z'
breakdown:
success: 0.95
error_plaid: 0.02
error_institution: 0.03
refresh_interval: NORMAL
auth:
status: HEALTHY
last_status_change: '2019-02-15T15:53:00Z'
breakdown:
success: 0.91
error_plaid: 0.01
error_institution: 0.08
balance:
status: HEALTHY
last_status_change: '2019-02-15T15:53:00Z'
breakdown:
success: 0.89
error_plaid: 0.02
error_institution: 0.09
identity:
status: DEGRADED
last_status_change: '2019-02-15T15:50:00Z'
breakdown:
success: 0.42
error_plaid: 0.08
error_institution: 0.5
investments:
status: HEALTHY
last_status_change: '2019-02-15T15:53:00Z'
breakdown:
success: 0.89
error_plaid: 0.02
error_institution: 0.09
liabilities:
status: HEALTHY
last_status_change: '2019-02-15T15:53:00Z'
breakdown:
success: 0.89
error_plaid: 0.02
error_institution: 0.09
investments_updates:
status: HEALTHY
last_status_change: '2019-02-12T08:22:00Z'
breakdown:
success: 0.95
error_plaid: 0.02
error_institution: 0.03
refresh_interval: NORMAL
liabilities_updates:
status: HEALTHY
last_status_change: '2019-02-12T08:22:00Z'
breakdown:
success: 0.95
error_plaid: 0.02
error_institution: 0.03
refresh_interval: NORMAL
primary_color: '#004966'
url: 'https://plaid.com'
logo: null
request_id: m8MDnv9okwxFNBV
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Error response
description: |
Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InstitutionsGetByIdRequest'
description: ''
/item/remove:
post:
tags:
- plaid
summary: Remove an Item
externalDocs:
url: /api/items/#itemremove
operationId: itemRemove
description: |-
The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token` associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item.
Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support.
Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.
API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRemoveResponse'
examples:
example-1:
value:
request_id: m8MDnv9okwxFNBV
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRemoveRequest'
description: ''
/accounts/get:
post:
tags:
- plaid
summary: Retrieve accounts
externalDocs:
url: /api/accounts/#accountsget
operationId: accountsGet
description: |-
The `/accounts/get` endpoint can be used to retrieve information for any linked Item. Note that some information is nullable. Plaid will only return active bank accounts, i.e. accounts that are not closed and are capable of carrying a balance.
This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead.
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsGetResponse'
examples:
example-1:
value:
accounts:
- account_id: blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
- account_id: 6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk
balances:
available: null
current: 23631.9805
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '6666'
name: Plaid 401k
official_name: null
subtype: 401k
type: investment
- account_id: XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58
balances:
available: null
current: 65262
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '7777'
name: Plaid Student Loan
official_name: null
subtype: student
type: loan
item:
available_products:
- balance
- identity
- payment_initiation
- transactions
billed_products:
- assets
- auth
consent_expiration_time: null
error: null
institution_id: ins_117650
item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
request_id: bkVE1BHWMAZ9Rnr
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsGetRequest'
examples:
example-1:
value:
client_id: string
secret: string
access_token: string
options:
account_ids:
- string
/categories/get:
post:
security: []
tags:
- plaid
summary: Get Categories
externalDocs:
url: /api/products/#categoriesget
operationId: categoriesGet
description: Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesGetResponse'
examples:
example-1:
value:
categories:
- category_id: '10000000'
group: special
hierarchy:
- Bank Fees
- category_id: '10001000'
group: special
hierarchy:
- Bank Fees
- Overdraft
- category_id: '12001000'
group: place
hierarchy:
- Community
- Animal Shelter
request_id: ixTBLZGvhD4NnmB
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CategoriesGetRequest'
/sandbox/processor_token/create:
post:
tags:
- plaid
summary: Create a test Item and processor token
externalDocs:
url: /api/sandbox/#sandboxprocessor_tokencreate
operationId: sandboxProcessorTokenCreate
description: 'Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxProcessorTokenCreateResponse'
examples:
example-1:
value:
processor_token: processor-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
request_id: Aim3b
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxProcessorTokenCreateRequest'
/sandbox/public_token/create:
post:
tags:
- plaid
summary: Create a test Item
externalDocs:
url: /api/sandbox/#sandboxpublic_tokencreate
operationId: sandboxPublicTokenCreate
description: 'Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. `/sandbox/public_token/create` cannot be used with OAuth institutions.'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxPublicTokenCreateResponse'
examples:
example-1:
value:
public_token: public-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
request_id: Aim3b
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxPublicTokenCreateRequest'
/sandbox/item/fire_webhook:
post:
tags:
- plaid
summary: Fire a test webhook
externalDocs:
url: /api/sandbox/#sandboxitemfire_webhook
operationId: sandboxItemFireWebhook
description: 'The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions `DEFAULT_UPDATE` webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.'
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemFireWebhookResponse'
examples:
example-1:
value:
webhook_fired: true
request_id: 1vwmF5TBQwiqfwP
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemFireWebhookRequest'
/accounts/balance/get:
post:
tags:
- plaid
summary: Retrieve real-time balance data
externalDocs:
url: /api/products/#accountsbalanceget
operationId: accountsBalanceGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsGetResponse'
examples:
example-1:
value:
accounts:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
- account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
balances:
available: null
current: 410
iso_currency_code: USD
limit: 2000
unofficial_currency_code: null
mask: '3333'
name: Plaid Credit Card
official_name: Plaid Diamond 12.5% APR Interest Credit Card
subtype: credit card
type: credit
- account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
balances:
available: null
current: 65262
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '7777'
name: Plaid Student Loan
official_name: null
subtype: student
type: loan
item:
available_products:
- balance
- identity
- investments
billed_products:
- assets
- auth
- liabilities
- transactions
consent_expiration_time: null
error: null
institution_id: ins_3
item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
request_id: qk5Bxes3gDfv4F2
description: 'The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item''s accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AccountsBalanceGetRequest'
examples:
example-1:
value:
access_token: string
secret: string
client_id: string
options:
account_ids:
- string
/identity/get:
post:
tags:
- plaid
summary: Retrieve identity data
externalDocs:
url: /api/products/#identityget
operationId: identityGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IdentityGetResponse'
examples:
example-1:
value:
accounts:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
owners:
- addresses:
- data:
city: Malakoff
country: US
postal_code: '14236'
region: NY
street: 2992 Cameron Road
primary: true
- data:
city: San Matias
country: US
postal_code: 93405-2255
region: CA
street: 2493 Leisure Lane
primary: false
emails:
- data: accountholder0@example.com
primary: true
type: primary
- data: accountholder1@example.com
primary: false
type: secondary
- data: extraordinarily.long.email.username.123456@reallylonghostname.com
primary: false
type: other
names:
- Alberta Bobbeth Charleson
phone_numbers:
- data: '1112223333'
primary: false
type: home
- data: '1112224444'
primary: false
type: work
- data: '1112225555'
primary: false
type: mobile
subtype: checking
type: depository
- account_id: 3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr
balances:
available: 200
current: 210
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '1111'
name: Plaid Saving
official_name: Plaid Silver Standard 0.1% Interest Saving
owners:
- addresses:
- data:
city: Malakoff
country: US
postal_code: '14236'
region: NY
street: 2992 Cameron Road
primary: true
- data:
city: San Matias
country: US
postal_code: 93405-2255
region: CA
street: 2493 Leisure Lane
primary: false
emails:
- data: accountholder0@example.com
primary: true
type: primary
- data: accountholder1@example.com
primary: false
type: secondary
- data: extraordinarily.long.email.username.123456@reallylonghostname.com
primary: false
type: other
names:
- Alberta Bobbeth Charleson
phone_numbers:
- data: '1112223333'
primary: false
type: home
- data: '1112224444'
primary: false
type: work
- data: '1112225555'
primary: false
type: mobile
subtype: savings
type: depository
item:
available_products:
- balance
- investments
billed_products:
- assets
- auth
- identity
- liabilities
- transactions
consent_expiration_time: null
error: null
institution_id: ins_3
item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
request_id: 3nARps6TOYtbACO
description: |-
The `/identity/get` 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.
Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IdentityGetRequest'
description: ''
/processor/auth/get:
post:
tags:
- plaid
summary: Retrieve Auth data
externalDocs:
url: /api/processors/#processorauthget
operationId: processorAuthGet
responses:
'200':
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorAuthGetResponse'
x-examples:
example-1:
value:
account:
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Checking
subtype: checking
type: depository
numbers:
ach:
account: '9900009606'
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
routing: '011401533'
wire_routing: '021000021'
eft:
account: '111122223333'
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
institution: '021'
branch: '01140'
international:
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
bic: NWBKGB21
iban: GB29NWBK60161331926819
bacs:
account: '31926819'
account_id: vzeNDwK7KQIm4yEog683uElbp9GRLEFXGK98D
sort_code: '601613'
request_id: 1zlMf
description: |
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.
Versioning 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/versioning/#version-2020-09-14).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorAuthGetRequest'
/processor/bank_transfer/create:
post:
tags:
- plaid
summary: Create a bank transfer as a processor
externalDocs:
url: /api/processors/#bank_transfercreate
operationId: processorBankTransferCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorBankTransferCreateResponse'
examples:
example-1:
value:
bank_transfer:
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
cancellable: true
created: '2020-08-06T17:27:15Z'
custom_tag: my tag
description: Testing2
direction: outbound
failure_reason: null
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
iso_currency_code: USD
metadata:
key1: value1
key2: value2
network: ach
origination_account_id: 11111111-1111-1111-1111-111111111111
status: pending
type: credit
user:
email_address: plaid@plaid.com
legal_name: John Smith
routing_number: '111111111'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorBankTransferCreateRequest'
/processor/identity/get:
post:
tags:
- plaid
summary: Retrieve Identity data
externalDocs:
url: /api/processors/#processoridentityget
operationId: processorIdentityGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorIdentityGetResponse'
examples:
example-1:
value:
account:
account_id: XMGPJy4q1gsQoKd5z9R3tK8kJ9EWL8SdkgKMq
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
owners:
- addresses:
- data:
city: Malakoff
country: US
postal_code: '14236'
region: NY
street: 2992 Cameron Road
primary: true
- data:
city: San Matias
country: US
postal_code: 93405-2255
region: CA
street: 2493 Leisure Lane
primary: false
emails:
- data: accountholder0@example.com
primary: true
type: primary
- data: accountholder1@example.com
primary: false
type: secondary
- data: extraordinarily.long.email.username.123456@reallylonghostname.com
primary: false
type: other
names:
- Alberta Bobbeth Charleson
phone_numbers:
- data: '1112223333'
primary: false
type: home
- data: '1112224444'
primary: false
type: work
- data: '1112225555'
primary: false
type: mobile1
subtype: checking
type: depository
request_id: eOPkBl6t33veI2J
description: '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.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorIdentityGetRequest'
/processor/balance/get:
post:
tags:
- plaid
summary: Retrieve Balance data
externalDocs:
url: /api/processors/#processorbalanceget
operationId: processorBalanceGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorBalanceGetResponse'
examples:
example-1:
value:
account:
account_id: QKKzevvp33HxPWpoqn6rI13BxW4awNSjnw4xv
balances:
available: 100
current: 110
limit: null
iso_currency_code: USD
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Checking
subtype: checking
type: depository
request_id: 1zlMf
description: '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. '
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorBalanceGetRequest'
description: |-
The `/processor/balance/get` endpoint returns the real-time balance for the account associated with a given `processor_token`.
The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account.
Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of `null`.
/item/webhook/update:
post:
tags:
- plaid
summary: Update Webhook URL
externalDocs:
url: /api/items/#itemwebhookupdate
operationId: itemWebhookUpdate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItemWebhookUpdateResponse'
examples:
example-1:
value:
item:
available_products:
- balance
- identity
- payment_initiation
- transactions
billed_products:
- assets
- auth
consent_expiration_time: null
error: null
institution_id: ins_117650
item_id: DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
request_id: vYK11LNTfRoAMbj
description: 'The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-url-updated) webhook to the newly specified webhook URL.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemWebhookUpdateRequest'
/item/access_token/invalidate:
post:
tags:
- plaid
summary: Invalidate access_token
externalDocs:
url: /api/tokens/#itemaccess_tokeninvalidate
operationId: itemAccessTokenInvalidate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItemAccessTokenInvalidateResponse'
examples:
example-1:
value:
new_access_token: access-sandbox-8ab976e6-64bc-4b38-98f7-731e7a349970
request_id: m8MDnv9okwxFNBV
description: |
By default, the `access_token` associated with an Item does not expire and should be stored in a persistent, secure manner.
You can use the `/item/access_token/invalidate` endpoint to rotate the `access_token` associated with an Item. The endpoint returns a new `access_token` and immediately invalidates the previous `access_token`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemAccessTokenInvalidateRequest'
/webhook_verification_key/get:
post:
tags:
- plaid
summary: Get webhook verification key
externalDocs:
url: /api/webhooks/webhook-verification/#webhook_verification_keyget
operationId: webhookVerificationKeyGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookVerificationKeyGetResponse'
examples:
example-1:
value:
key:
alg: ES256
created_at: 1560466150
crv: P-256
expired_at: null
kid: bfbd5111-8e33-4643-8ced-b2e642a72f3c
kty: EC
use: sig
x: hKXLGIjWvCBv-cP5euCTxl8g9GLG9zHo_3pO5NN1DwQ
'y': shhexqPB7YffGn6fR6h2UhTSuCtPmfzQJ6ENVIoO4Ys
request_id: RZ6Omi1bzzwDaLo
description: |-
Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header.
The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookVerificationKeyGetRequest'
description: ''
/liabilities/get:
post:
tags:
- plaid
summary: Retrieve Liabilities data
externalDocs:
url: /api/products/#liabilitiesget
operationId: liabilitiesGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LiabilitiesGetResponse'
examples:
example-1:
value:
accounts:
- account_id: BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
- account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
balances:
available: null
current: 410
iso_currency_code: USD
limit: 2000
unofficial_currency_code: null
mask: '3333'
name: Plaid Credit Card
official_name: Plaid Diamond 12.5% APR Interest Credit Card
subtype: credit card
type: credit
- account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
balances:
available: null
current: 65262
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '7777'
name: Plaid Student Loan
official_name: null
subtype: student
type: loan
- account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
balances:
available: null
current: 56302.06
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '8888'
name: Plaid Mortgage
official_name: null
subtype: mortgage
type: loan
item:
available_products:
- balance
- investments
billed_products:
- assets
- auth
- identity
- liabilities
- transactions
consent_expiration_time: null
error: null
institution_id: ins_3
item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
liabilities:
credit:
- account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
aprs:
- apr_percentage: 15.24
apr_type: balance_transfer_apr
balance_subject_to_apr: 1562.32
interest_charge_amount: 130.22
- apr_percentage: 27.95
apr_type: cash_apr
balance_subject_to_apr: 56.22
interest_charge_amount: 14.81
- apr_percentage: 12.5
apr_type: purchase_apr
balance_subject_to_apr: 157.01
interest_charge_amount: 25.66
- apr_percentage: 0
apr_type: special
balance_subject_to_apr: 1000
interest_charge_amount: 0
is_overdue: false
last_payment_amount: 168.25
last_payment_date: '2019-05-22'
last_statement_issue_date: '2019-05-28'
last_statement_balance: 1708.77
minimum_payment_amount: 20
next_payment_due_date: '2020-05-28'
mortgage:
- account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
account_number: '3120194154'
current_late_fee: 25
escrow_balance: 3141.54
has_pmi: true
has_prepayment_penalty: true
interest_rate:
percentage: 3.99
type: fixed
last_payment_amount: 3141.54
last_payment_date: '2019-08-01'
loan_term: 30 year
loan_type_description: conventional
maturity_date: '2045-07-31'
next_monthly_payment: 3141.54
next_payment_due_date: '2019-11-15'
origination_date: '2015-08-01'
origination_principal_amount: 425000
past_due_amount: 2304
property_address:
city: Malakoff
country: US
postal_code: '14236'
region: NY
street: 2992 Cameron Road
ytd_interest_paid: 12300.4
ytd_principal_paid: 12340.5
student:
- account_id: Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE
account_number: '4277075694'
disbursement_dates:
- '2002-08-28'
expected_payoff_date: '2032-07-28'
guarantor: DEPT OF ED
interest_rate_percentage: 5.25
is_overdue: false
last_payment_amount: 138.05
last_payment_date: '2019-04-22'
last_statement_issue_date: '2019-04-28'
loan_name: Consolidation
loan_status:
end_date: '2032-07-28'
type: repayment
minimum_payment_amount: 25
next_payment_due_date: '2019-05-28'
origination_date: '2002-08-28'
origination_principal_amount: 25000
outstanding_interest_amount: 6227.36
payment_reference_number: '4277075694'
pslf_status:
estimated_eligibility_date: '2021-01-01'
payments_made: 200
payments_remaining: 160
repayment_plan:
description: Standard Repayment
type: standard
sequence_number: '1'
servicer_address:
city: San Matias
country: US
postal_code: '99415'
region: CA
street: 123 Relaxation Road
ytd_interest_paid: 280.55
ytd_principal_paid: 271.65
request_id: dTnnm60WgKGLnKL
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LiabilitiesGetRequest'
description: |-
The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. 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`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate).
The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.
Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
/payment_initiation/recipient/create:
post:
tags:
- plaid
summary: Create payment recipient
externalDocs:
url: /api/products/#payment_initiationrecipientcreate
operationId: paymentInitiationRecipientCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationRecipientCreateResponse'
examples:
example-1:
value:
recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
request_id: 4zlKapIkTm8p5KM
description: |
Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK.
The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationRecipientCreateRequest'
/payment_initiation/payment/reverse:
post:
tags:
- plaid
summary: Reverse an existing payment
externalDocs:
url: /api/products/#payment_initiationpaymentreverse
operationId: paymentInitiationPaymentReverse
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentReverseResponse'
examples:
example-1:
value:
refund_id: refund-id-sandbox-c5f8cd31-6cae-4cad-9b0d-f7c10be9cc4b
request_id: HtlKzBX0fMeF7mU
status: INITIATED
description: |
Reverse a previously initiated payment.
A payment can only be reversed once and will be refunded to the original sender's account.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentReverseRequest'
/payment_initiation/recipient/get:
post:
tags:
- plaid
summary: Get payment recipient
externalDocs:
url: /api/products/#payment_initiationrecipientget
operationId: paymentInitiationRecipientGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationRecipientGetResponse'
x-examples:
example-1:
value:
recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
name: Wonder Wallet
iban: GB29NWBK60161331926819
address:
street:
- 96 Guild Street
- 9th Floor
city: London
postal_code: SE14 8JW
country: GB
request_id: 4zlKapIkTm8p5KM
description: Get details about a payment recipient you have previously created.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationRecipientGetRequest'
/payment_initiation/recipient/list:
post:
tags:
- plaid
summary: List payment recipients
externalDocs:
url: /api/products/#payment_initiationrecipientlist
operationId: paymentInitiationRecipientList
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationRecipientListResponse'
x-examples:
example-1:
value:
recipients:
- recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
name: Wonder Wallet
iban: GB29NWBK60161331926819
address:
street:
- 96 Guild Street
- 9th Floor
city: London
postal_code: SE14 8JW
country: GB
request_id: 4zlKapIkTm8p5KM
description: The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationRecipientListRequest'
/payment_initiation/payment/create:
post:
tags:
- plaid
summary: Create a payment
externalDocs:
url: /api/products/#payment_initiationpaymentcreate
operationId: paymentInitiationPaymentCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentCreateResponse'
examples:
example-1:
value:
payment_id: payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
status: PAYMENT_STATUS_INPUT_NEEDED
request_id: 4ciYVmesrySiUAB
description: |-
After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day.
Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentCreateRequest'
description: ''
/payment_initiation/payment/token/create:
post:
tags:
- plaid
deprecated: true
summary: Create payment token
externalDocs:
url: /link/maintain-legacy-integration/#creating-a-payment-token
operationId: createPaymentToken
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentTokenCreateResponse'
examples:
example-1:
value:
payment_token: payment-token-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
payment_token_expiration_time: '2020-01-01T00:00:00Z'
request_id: 4ciYVmesrySiUAB
description: |-
The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link.
The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentTokenCreateRequest'
/sandbox/item/reset_login:
post:
tags:
- plaid
summary: Force a Sandbox Item into an error state
externalDocs:
url: /api/sandbox/#sandboxitemreset_login
operationId: sandboxItemResetLogin
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemResetLoginResponse'
examples:
example-1:
value:
reset_login: true
request_id: m8MDnv9okwxFNBV
description: |-
`/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item.
In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemResetLoginRequest'
/sandbox/item/set_verification_status:
post:
tags:
- plaid
summary: Set verification status for Sandbox account
externalDocs:
url: /api/sandbox/#sandboxitemset_verification_status
operationId: sandboxItemSetVerificationStatus
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemSetVerificationStatusResponse'
examples:
example-1:
value:
request_id: 1vwmF5TBQwiqfwP
description: |-
The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow.
Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access).
For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxItemSetVerificationStatusRequest'
/item/public_token/exchange:
post:
tags:
- plaid
summary: Exchange public token for an access token
externalDocs:
url: /api/tokens/#itempublic_tokenexchange
operationId: itemPublicTokenExchange
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItemPublicTokenExchangeResponse'
examples:
example-1:
value:
access_token: access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6
item_id: M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op
request_id: Aim3b
description: |-
Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes.
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. The `item_id` can also be retrieved by making an `/item/get` request.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemPublicTokenExchangeRequest'
/item/public_token/create:
post:
tags:
- plaid
summary: Create public token
externalDocs:
url: /api/tokens/#itempublic_tokencreate
operationId: itemCreatePublicToken
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItemPublicTokenCreateResponse'
examples:
example-1:
value:
public_token: public-sandbox-b0e2c4ee-a763-4df5-bfe9-46a46bce993d
request_id: Aim3b
description: |-
Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode).
If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`.
A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally.
The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemPublicTokenCreateRequest'
/payment_initiation/payment/get:
post:
tags:
- plaid
summary: Get payment details
externalDocs:
url: /api/products/#payment_initiationpaymentget
operationId: paymentInitiationPaymentGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentGetResponse'
x-examples:
example-1:
value:
payment_id: payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
payment_token: payment-token-sandbox-c6a26505-42b4-46fe-8ecf-bf9edcafbebb
reference: Account Funding 99744
amount:
currency: GBP
value: 100
status: PAYMENT_STATUS_INPUT_NEEDED
last_status_update: '2019-11-06T21:10:52Z'
payment_expiration_time: '2019-11-06T21:25:52Z'
recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
bacs: null
iban: null
request_id: aEAQmewMzlVa1k6
description: 'The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentGetRequest'
description: ''
/payment_initiation/payment/list:
post:
tags:
- plaid
summary: List payments
externalDocs:
url: /api/products/#payment_initiationpaymentlist
operationId: paymentInitiationPaymentList
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentListResponse'
x-examples:
example-1:
value:
payments:
- payment_id: payment-id-sandbox-feca8a7a-5591-4aef-9297-f3062bb735d3
reference: Account Funding 99744
amount:
currency: GBP
value: 100
status: PAYMENT_STATUS_INPUT_NEEDED
last_status_update: '2019-11-06T21:10:52Z'
recipient_id: recipient-id-sandbox-9b6b4679-914b-445b-9450-efbdb80296f6
bacs: null
iban: null
next_cursor: '2020-01-01T00:00:00Z'
request_id: aEAQmewMzlVa1k6
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PaymentInitiationPaymentListRequest'
description: 'The `/payment_initiation/payment/list` endpoint can be used to retrieve all created payments. By default, the 10 most recent payments are returned. You can request more payments and paginate through the results using the optional `count` and `cursor` parameters.'
/asset_report/create:
post:
tags:
- plaid
summary: Create an Asset Report
externalDocs:
url: /api/products/#asset_reportcreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportCreateResponse'
examples:
example-1:
value:
asset_report_token: assets-sandbox-6f12f5bb-22dd-4855-b918-f47ec439198a
asset_report_id: 1f414183-220c-44f5-b0c8-bc0e6d4053bb
request_id: Iam3b
operationId: assetReportCreate
description: |-
The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints.
The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#Assets-webhooks).
The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportCreateRequest'
/asset_report/refresh:
post:
tags:
- plaid
summary: Refresh an Asset Report
externalDocs:
url: /api/products/#asset_reportrefresh
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportRefreshResponse'
examples:
example-1:
value:
asset_report_id: c33ebe8b-6a63-4d74-a83d-d39791231ac0
asset_report_token: assets-sandbox-8218d5f8-6d6d-403d-92f5-13a9afaa4398
request_id: NBZaq
operationId: assetReportRefresh
description: |-
An Asset Report is an immutable snapshot of a user's assets. In order to "refresh" an Asset Report you created previously, you can use the `/asset_report/refresh` endpoint to create a new Asset Report based on the old one, but with the most recent data available.
The new Asset Report will contain the same Items as the original Report, as well as the same filters applied by any call to `/asset_report/filter`. By default, the new Asset Report will also use the same parameters you submitted with your original `/asset_report/create` request, but the original `days_requested` value and the values of any parameters in the `options` object can be overridden with new values. To change these arguments, simply supply new values for them in your request to `/asset_report/refresh`. Submit an empty string ("") for any previously-populated fields you would like set as empty.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportRefreshRequest'
description: ''
/asset_report/remove:
post:
tags:
- plaid
summary: Delete an Asset Report
externalDocs:
url: /api/products/#asset_reportremove
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportRemoveResponse'
examples:
example-1:
value:
removed: true
request_id: I6zHN
operationId: assetReportRemove
description: |-
The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically.
The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportRemoveRequest'
description: ''
/asset_report/filter:
post:
tags:
- plaid
summary: Filter Asset Report
externalDocs:
url: /api/products/#asset_reportfilter
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportFilterResponse'
examples:
example-1:
value:
asset_report_token: assets-sandbox-bc410c6a-4653-4c75-985c-e757c3497c5c
asset_report_id: fdc09207-0cef-4d88-b5eb-0d970758ebd9
request_id: qEg07
operationId: assetReportFilter
description: |-
By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint.
To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data.
Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed.
Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportFilterRequest'
description: ''
/asset_report/get:
post:
tags:
- plaid
summary: Retrieve an Asset Report
externalDocs:
url: /api/products/#asset_reportget
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportGetResponse'
examples:
example-1:
value:
report:
asset_report_id: bf3a0490-344c-4620-a219-2693162e4b1d
client_report_id: 123abc
date_generated: '2020-06-05T22:47:53Z'
days_requested: 3
items:
- accounts:
- account_id: 3gE5gnRzNyfXpBK5wEEKcymJ5albGVUqg77gr
balances:
available: 200
current: 210
iso_currency_code: USD
limit: null
unofficial_currency_code: null
days_available: 3
historical_balances:
- current: 210
date: '2020-06-04'
iso_currency_code: USD
unofficial_currency_code: null
- current: 210
date: '2020-06-03'
iso_currency_code: USD
unofficial_currency_code: null
- current: 210
date: '2020-06-02'
iso_currency_code: USD
unofficial_currency_code: null
mask: '1111'
name: Plaid Saving
official_name: Plaid Silver Standard 0.1% Interest Saving
owners:
- addresses:
- data:
city: Malakoff
country: US
postal_code: '14236'
region: NY
street: 2992 Cameron Road
primary: true
- data:
city: San Matias
country: US
postal_code: 93405-2255
region: CA
street: 2493 Leisure Lane
primary: false
emails:
- data: accountholder0@example.com
primary: true
type: primary
- data: accountholder1@example.com
primary: false
type: secondary
- data: extraordinarily.long.email.username.123456@reallylonghostname.com
primary: false
type: other
names:
- Alberta Bobbeth Charleson
phone_numbers:
- data: '1112223333'
primary: false
type: home
- data: '1112224444'
primary: false
type: work
- data: '1112225555'
primary: false
type: mobile
ownership_type: null
subtype: savings
transactions: []
type: depository
- account_id: BxBXxLj1m4HMXBm9WZJyUg9XLd4rKEhw8Pb1J
balances:
available: null
current: 56302.06
iso_currency_code: USD
limit: null
unofficial_currency_code: null
days_available: 3
historical_balances: []
mask: '8888'
name: Plaid Mortgage
official_name: null
owners:
- addresses:
- data:
city: Malakoff
country: US
postal_code: '14236'
region: NY
street: 2992 Cameron Road
primary: true
- data:
city: San Matias
country: US
postal_code: 93405-2255
region: CA
street: 2493 Leisure Lane
primary: false
emails:
- data: accountholder0@example.com
primary: true
type: primary
- data: accountholder1@example.com
primary: false
type: secondary
- data: extraordinarily.long.email.username.123456@reallylonghostname.com
primary: false
type: other
names:
- Alberta Bobbeth Charleson
phone_numbers:
- data: '1112223333'
primary: false
type: home
- data: '1112224444'
primary: false
type: work
- data: '1112225555'
primary: false
type: mobile
ownership_type: null
subtype: mortgage
transactions: []
type: loan
- account_id: dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK
balances:
available: null
current: 410
iso_currency_code: USD
limit: null
unofficial_currency_code: null
days_available: 3
historical_balances:
- current: 410
date: '2020-06-04'
iso_currency_code: USD
unofficial_currency_code: null
- current: 410
date: '2020-06-03'
iso_currency_code: USD
unofficial_currency_code: null
- current: 410
date: '2020-06-02'
iso_currency_code: USD
unofficial_currency_code: null
mask: '3333'
name: Plaid Credit Card
official_name: Plaid Diamond 12.5% APR Interest Credit Card
owners:
- addresses:
- data:
city: Malakoff
country: US
postal_code: '14236'
region: NY
street: 2992 Cameron Road
primary: true
- data:
city: San Matias
country: US
postal_code: 93405-2255
region: CA
street: 2493 Leisure Lane
primary: false
emails:
- data: accountholder0@example.com
primary: true
type: primary
- data: accountholder1@example.com
primary: false
type: secondary
- data: extraordinarily.long.email.username.123456@reallylonghostname.com
primary: false
type: other
names:
- Alberta Bobbeth Charleson
phone_numbers:
- data: '1112223333'
primary: false
type: home
- data: '1112224444'
primary: false
type: work
- data: '1112225555'
primary: false
type: mobile
ownership_type: null
subtype: credit card
transactions: []
type: credit
date_last_updated: '2020-06-05T22:47:52Z'
institution_id: ins_3
institution_name: Chase
item_id: eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6
user:
client_user_id: '123456789'
email: accountholder0@example.com
first_name: Alberta
last_name: Charleson
middle_name: Bobbeth
phone_number: 111-222-3333
ssn: 123-45-6789
request_id: eYupqX1mZkEuQRx
warnings: []
operationId: assetReportGet
description: |-
The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved.
By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report.
To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportGetRequest'
description: ''
/asset_report/pdf/get:
post:
tags:
- plaid
summary: Retrieve a PDF Asset Report
externalDocs:
url: /api/products/#asset_reportpdfget
responses:
'200':
description: A PDF of the Asset Report
content:
application/pdf:
schema:
$ref: '#/components/schemas/AssetReportPDFGetResponse'
operationId: assetReportPdfGet
description: |-
The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved.
The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
[View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportPDFGetRequest'
description: ''
/asset_report/audit_copy/create:
post:
tags:
- plaid
summary: Create Asset Report Audit Copy
externalDocs:
url: /api/products/#asset_reportaudit_copycreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportAuditCopyCreateResponse'
examples:
example-1:
value:
audit_copy_token: a-sandbox-3TAU2CWVYBDVRHUCAAAI27ULU4
request_id: Iam3b
operationId: assetReportAuditCopyCreate
description: |-
Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report.
To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportAuditCopyCreateRequest'
/asset_report/audit_copy/remove:
post:
tags:
- plaid
summary: Remove Asset Report Audit Copy
externalDocs:
url: /api/products/#asset_reportaudit_copyremove
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportAuditCopyRemoveResponse'
examples:
example-1:
value:
removed: true
request_id: m8MDnv9okwxFNBV
operationId: assetReportAuditCopyRemove
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportAuditCopyRemoveRequest'
description: ''
description: 'The `/asset_report/audit_copy/remove` endpoint allows you to remove an Audit Copy. Removing an Audit Copy invalidates the `audit_copy_token` associated with it, meaning both you and any third parties holding the token will no longer be able to use it to access Report data. Items associated with the Asset Report, the Asset Report itself and other Audit Copies of it are not affected and will remain accessible after removing the given Audit Copy.'
/investments/holdings/get:
post:
tags:
- plaid
summary: Get Investment holdings
externalDocs:
url: /api/products/#investmentsholdingsget
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InvestmentsHoldingsGetResponse'
examples:
example-1:
value:
accounts:
- account_id: 5Bvpj4QknlhVWk7GygpwfVKdd133GoCxB814g
balances:
available: 43200
current: 43200
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '4444'
name: Plaid Money Market
official_name: Plaid Platinum Standard 1.85% Interest Money Market
subtype: money market
type: depository
- account_id: JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1
balances:
available: null
current: 320.76
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '5555'
name: Plaid IRA
official_name: null
subtype: ira
type: investment
- account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
balances:
available: null
current: 23631.9805
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '6666'
name: Plaid 401k
official_name: null
subtype: 401k
type: investment
holdings:
- account_id: JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1
cost_basis: 1
institution_price: 1
institution_price_as_of: '2021-04-13'
institution_value: 0.01
iso_currency_code: USD
quantity: 0.01
security_id: d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are
unofficial_currency_code: null
- account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
cost_basis: 1.5
institution_price: 2.11
institution_price_as_of: null
institution_value: 2.11
iso_currency_code: USD
quantity: 1
security_id: KDwjlXj1Rqt58dVvmzRguxJybmyQL8FgeWWAy
unofficial_currency_code: null
- account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
cost_basis: 10
institution_price: 10.42
institution_price_as_of: null
institution_value: 20.84
iso_currency_code: USD
quantity: 2
security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
unofficial_currency_code: null
- account_id: JqMLm4rJwpF6gMPJwBqdh9ZjjPvvpDcb7kDK1
cost_basis: 0.01
institution_price: 0.011
institution_price_as_of: null
institution_value: 110
iso_currency_code: USD
quantity: 10000
security_id: 8E4L9XLl6MudjEpwPAAgivmdZRdBPJuvMPlPb
unofficial_currency_code: null
- account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
cost_basis: 23
institution_price: 27
institution_price_as_of: null
institution_value: 636.309
iso_currency_code: USD
quantity: 23.567
security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
unofficial_currency_code: null
- account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
cost_basis: 15
institution_price: 13.73
institution_price_as_of: null
institution_value: 1373.6865
iso_currency_code: USD
quantity: 100.05
security_id: nnmo8doZ4lfKNEDe3mPJipLGkaGw3jfPrpxoN
unofficial_currency_code: null
- account_id: k67E4xKvMlhmleEa4pg9hlwGGNnnEeixPolGm
cost_basis: 1
institution_price: 1
institution_price_as_of: null
institution_value: 12345.67
iso_currency_code: USD
quantity: 12345.67
security_id: d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are
unofficial_currency_code: null
item:
available_products:
- balance
- identity
- liabilities
- transactions
billed_products:
- assets
- auth
- investments
consent_expiration_time: null
error: null
institution_id: ins_3
item_id: 4z9LPae1nRHWy8pvg9jrsgbRP4ZNQvIdbLq7g
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
request_id: l68wb8zpS0hqmsJ
securities:
- close_price: 0.011
close_price_as_of: '2021-04-13'
cusip: null
institution_id: null
institution_security_id: null
is_cash_equivalent: false
isin: null
iso_currency_code: USD
name: Nflx Feb 01'18 $355 Call
proxy_security_id: null
security_id: 8E4L9XLl6MudjEpwPAAgivmdZRdBPJuvMPlPb
sedol: null
ticker_symbol: NFLX180201C00355000
type: derivative
unofficial_currency_code: null
- close_price: 27
close_price_as_of: null
cusip: '577130834'
institution_id: null
institution_security_id: null
is_cash_equivalent: false
isin: US5771308344
iso_currency_code: USD
name: Matthews Pacific Tiger Fund Insti Class
proxy_security_id: null
security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
sedol: null
ticker_symbol: MIPTX
type: mutual fund
unofficial_currency_code: null
- close_price: 2.11
close_price_as_of: null
cusip: 00448Q201
institution_id: null
institution_security_id: null
is_cash_equivalent: false
isin: US00448Q2012
iso_currency_code: USD
name: Achillion Pharmaceuticals Inc.
proxy_security_id: null
security_id: KDwjlXj1Rqt58dVvmzRguxJybmyQL8FgeWWAy
sedol: null
ticker_symbol: ACHN
type: equity
unofficial_currency_code: null
- close_price: 10.42
close_price_as_of: null
cusip: '258620103'
institution_id: null
institution_security_id: null
is_cash_equivalent: false
isin: US2586201038
iso_currency_code: USD
name: DoubleLine Total Return Bond Fund
proxy_security_id: null
security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
sedol: null
ticker_symbol: DBLTX
type: mutual fund
unofficial_currency_code: null
- close_price: 1
close_price_as_of: null
cusip: null
institution_id: null
institution_security_id: null
is_cash_equivalent: true
isin: null
iso_currency_code: USD
name: U S Dollar
proxy_security_id: null
security_id: d6ePmbPxgWCWmMVv66q9iPV94n91vMtov5Are
sedol: null
ticker_symbol: USD
type: cash
unofficial_currency_code: null
- close_price: 13.73
close_price_as_of: null
cusip: null
institution_id: ins_3
institution_security_id: NHX105509
is_cash_equivalent: false
isin: null
iso_currency_code: USD
name: NH PORTFOLIO 1055 (FIDELITY INDEX)
proxy_security_id: null
security_id: nnmo8doZ4lfKNEDe3mPJipLGkaGw3jfPrpxoN
sedol: null
ticker_symbol: NHX105509
type: etf
unofficial_currency_code: null
operationId: investmentsHoldingsGet
description: The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InvestmentsHoldingsGetRequest'
/investments/transactions/get:
post:
tags:
- plaid
summary: Get investment transactions
externalDocs:
url: /api/products/#investmentstransactionsget
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InvestmentsTransactionsGetResponse'
examples:
example-1:
value:
accounts:
- account_id: 5e66Dl6jNatx3nXPGwZ7UkJed4z6KBcZA4Rbe
balances:
available: 100
current: 110
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '0000'
name: Plaid Checking
official_name: Plaid Gold Standard 0% Interest Checking
subtype: checking
type: depository
- account_id: KqZZMoZmBWHJlz7yKaZjHZb78VNpaxfVa7e5z
balances:
available: null
current: 320.76
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '5555'
name: Plaid IRA
official_name: null
subtype: ira
type: investment
- account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
balances:
available: null
current: 23631.9805
iso_currency_code: USD
limit: null
unofficial_currency_code: null
mask: '6666'
name: Plaid 401k
official_name: null
subtype: 401k
type: investment
investment_transactions:
- account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
amount: -8.72
cancel_transaction_id: null
date: '2020-05-29'
fees: 0
investment_transaction_id: oq99Pz97joHQem4BNjXECev1E4B6L6sRzwANW
iso_currency_code: USD
name: INCOME DIV DIVIDEND RECEIVED
price: 0
quantity: 0
security_id: eW4jmnjd6AtjxXVrjmj6SX1dNEdZp3Cy8RnRQ
subtype: dividend
type: cash
unofficial_currency_code: null
- account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
amount: -1289.01
cancel_transaction_id: null
date: '2020-05-28'
fees: 7.99
investment_transaction_id: pK99jB9e7mtwjA435GpVuMvmWQKVbVFLWme57
iso_currency_code: USD
name: SELL Matthews Pacific Tiger Fund Insti Class
price: 27.53
quantity: -47.74104242992852
security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
subtype: sell
type: sell
unofficial_currency_code: null
- account_id: rz99ex9ZQotvnjXdgQLEsR81e3ArPgulVWjGj
amount: 7.7
cancel_transaction_id: null
date: '2020-05-27'
fees: 7.99
investment_transaction_id: LKoo1ko93wtreBwM7yQnuQ3P5DNKbKSPRzBNv
iso_currency_code: USD
name: BUY DoubleLine Total Return Bond Fund
price: 10.42
quantity: 0.7388014749727547
security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
subtype: buy
type: buy
unofficial_currency_code: null
item:
available_products:
- assets
- balance
- identity
- transactions
billed_products:
- auth
- investments
consent_expiration_time: null
error: null
institution_id: ins_12
item_id: 8Mqq5rqQ7Pcxq9MGDv3JULZ6yzZDLMCwoxGDq
update_type: background
webhook: 'https://www.genericwebhookurl.com/webhook'
request_id: iv4q3ZlytOOthkv
securities:
- close_price: 27
close_price_as_of: null
cusip: '577130834'
institution_id: null
institution_security_id: null
is_cash_equivalent: false
isin: US5771308344
iso_currency_code: USD
name: Matthews Pacific Tiger Fund Insti Class
proxy_security_id: null
security_id: JDdP7XPMklt5vwPmDN45t3KAoWAPmjtpaW7DP
sedol: null
ticker_symbol: MIPTX
type: mutual fund
unofficial_currency_code: null
- close_price: 10.42
close_price_as_of: null
cusip: '258620103'
institution_id: null
institution_security_id: null
is_cash_equivalent: false
isin: US2586201038
iso_currency_code: USD
name: DoubleLine Total Return Bond Fund
proxy_security_id: null
security_id: NDVQrXQoqzt5v3bAe8qRt4A7mK7wvZCLEBBJk
sedol: null
ticker_symbol: DBLTX
type: mutual fund
unofficial_currency_code: null
- close_price: 34.73
close_price_as_of: null
cusip: 84470P109
institution_id: null
institution_security_id: null
is_cash_equivalent: false
isin: US84470P1093
iso_currency_code: USD
name: Southside Bancshares Inc.
proxy_security_id: null
security_id: eW4jmnjd6AtjxXVrjmj6SX1dNEdZp3Cy8RnRQ
sedol: null
ticker_symbol: SBSI
type: equity
unofficial_currency_code: null
total_investment_transactions: 3
operationId: investmentsTransactionsGet
description: |-
The `/investments/transactions/get` endpoint allows developers to retrieve user-authorized transaction data for investment accounts.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift.
Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/InvestmentsTransactionsGetRequest'
/processor/token/create:
post:
tags:
- plaid
summary: Create processor token
externalDocs:
url: /api/processors/#processortokencreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorTokenCreateResponse'
examples:
example-1:
value:
processor_token: processor-sandbox-0asd1-a92nc
request_id: xrQNYZ7Zoh6R7gV
operationId: processorTokenCreate
description: 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.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorTokenCreateRequest'
description: ''
/processor/stripe/bank_account_token/create:
post:
tags:
- plaid
summary: Create Stripe bank account token
externalDocs:
url: /api/processors/#processorstripebank_account_tokencreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorStripeBankAccountTokenCreateResponse'
examples:
example-1:
value:
stripe_bank_account_token: btok_5oEetfLzPklE1fwJZ7SG
request_id: xrQNYZ7Zoh6R7gV
operationId: processorStripeBankAccountTokenCreate
description: 'Used 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/).'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorStripeBankAccountTokenCreateRequest'
description: ''
/processor/apex/processor_token/create:
post:
tags:
- plaid
summary: Create Apex bank account token
externalDocs:
url: /none/
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorTokenCreateResponse'
operationId: processorApexProcessorTokenCreate
description: Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ProcessorApexProcessorTokenCreateRequest'
description: ''
/deposit_switch/create:
post:
tags:
- plaid
summary: Create a deposit switch
externalDocs:
url: /api/products#deposit_switchcreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchCreateResponse'
examples:
example-1:
value:
deposit_switch_id: c7jMwPPManIwy9rwMewWP7lpb4pKRbtrbMomp
request_id: lMjeOeu9X1VUh1F
operationId: depositSwitchCreate
description: This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchCreateRequest'
/item/import:
post:
tags:
- plaid
summary: Import Item
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ItemImportResponse'
examples:
example-1:
value:
access_token: access-sandbox-99ace160-3cf7-4e51-a083-403633425815
request_id: ewIBAn6RZirsk4W
operationId: itemImport
description: |-
`/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you.
Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ItemImportRequest'
/deposit_switch/token/create:
post:
tags:
- plaid
summary: Create a deposit switch token
externalDocs:
url: /deposit-switch/reference#deposit_switchtokencreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchTokenCreateResponse'
examples:
example-1:
value:
deposit_switch_token: deposit-switch-sandbox-3e5cacca-10a6-11ea-bcdb-6003089acac0
deposit_switch_token_expiration_time: '2019-12-31T12:01:37Z'
request_id: 68MvHx4Ub5NYoXt
operationId: depositSwitchTokenCreate
description: |
In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchTokenCreateRequest'
/link/token/create:
post:
tags:
- plaid
summary: Create Link Token
externalDocs:
url: /api/tokens/#linktokencreate
operationId: linkTokenCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LinkTokenCreateResponse'
examples:
example-1:
value:
link_token: link-sandbox-af1a0311-da53-4636-b754-dd15cc058176
expiration: '2020-03-27T12:56:34Z'
request_id: XQVgFigpGHXkb0b
description: |-
The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow.
A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LinkTokenCreateRequest'
description: ''
/link/token/get:
post:
tags:
- plaid
summary: Get Link Token
externalDocs:
url: /api/tokens/#linktokenget
operationId: linkTokenGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/LinkTokenGetResponse'
examples:
example-1:
value:
created_at: '2020-12-02T21:14:54Z'
expiration: '2020-12-03T01:14:54Z'
link_token: link-sandbox-33792986-2b9c-4b80-b1f2-518caaac6183
metadata:
account_filters:
depository:
account_subtypes:
- checking
- savings
client_name: Insert Client name here
country_codes:
- US
initial_products:
- auth
language: en
redirect_uri: null
webhook: 'https://www.example.com/webhook'
request_id: u0ydFs493XjyTYn
description: |-
The `/link/token/get` endpoint gets information about a previously-created `link_token` using the
`/link/token/create` endpoint. It can be useful for debugging purposes.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LinkTokenGetRequest'
description: ''
/asset_report/audit_copy/get:
post:
summary: Retrieve an Asset Report Audit Copy
tags:
- plaid
operationId: assetReportAuditCopyGet
externalDocs:
url: /none/
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportAuditCopyGetRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AssetReportGetResponse'
description: '`/asset_report/audit_copy/get` allows auditors to get a copy of an Asset Report that was previously shared via the `/asset_report/audit_copy/create` endpoint. The caller of `/asset_report/audit_copy/create` must provide the `audit_copy_token` to the auditor. This token can then be used to call `/asset_report/audit_copy/create`.'
/deposit_switch/get:
post:
summary: Retrieve a deposit switch
externalDocs:
url: /api/products#deposit_switchget
tags:
- plaid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchGetResponse'
examples:
example-1:
value:
target_item_id: MdRAkq1QikR3BLjDyMfMkVpqLmEm1VR7bX5hE
target_account_id: bX5hEMdRAkq1QikR3BLjDyMfMkVpqLmEm1VR7
deposit_switch_id: LjDyMfMkVpqLmEm1VR7bQikR3BX5hEMdRAkq1
state: completed
switch_method: instant
date_created: '2019-11-01'
date_completed: '2019-11-01'
account_has_multiple_allocations: true
is_allocated_remainder: false
percent_allocated: 50
amount_allocated: null
employer_name: COMPANY INC
employer_id: pqLmEm1VR7bQi11231
institution_name: Bank of America
institution_id: ins_1
request_id: lMjeOeu9X1VUh1F
operationId: depositSwitchGet
description: This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DepositSwitchGetRequest'
parameters: []
/transfer/get:
post:
summary: Retrieve a transfer
tags:
- plaid
externalDocs:
url: /transfer/reference#transferget
operationId: transferGet
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TransferGetResponse'
examples:
example-1:
value:
transfer:
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
cancellable: true
created: '2020-08-06T17:27:15Z'
description: Testing2
failure_reason:
ach_return_code: R13
description: Invalid ACH routing number
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
metadata:
key1: value1
key2: value2
network: ach
origination_account_id: 11111111-1111-1111-1111-111111111111
status: pending
type: credit
user:
email_address: plaid@plaid.com
legal_name: John Smith
phone_number: null
address: null
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferGetRequest'
examples: {}
parameters: []
/bank_transfer/get:
post:
summary: Retrieve a bank transfer
tags:
- plaid
externalDocs:
url: /api/products#bank_transferget
operationId: bankTransferGet
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferGetResponse'
examples:
example-1:
value:
bank_transfer:
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
cancellable: true
created: '2020-08-06T17:27:15Z'
custom_tag: my tag
description: Testing2
direction: outbound
failure_reason:
ach_return_code: R13
description: Invalid ACH routing number
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
iso_currency_code: USD
metadata:
key1: value1
key2: value2
network: ach
origination_account_id: 11111111-1111-1111-1111-111111111111
status: pending
type: credit
user:
email_address: plaid@plaid.com
legal_name: John Smith
routing_number: '111111111'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferGetRequest'
examples: {}
parameters: []
/transfer/authorization/create:
post:
summary: Create a transfer authorization
tags:
- plaid
externalDocs:
url: /transfer/reference#transferauthorizationcreate
operationId: transferAuthorizationCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferAuthorizationCreateResponse'
examples:
example-1:
value:
authorization:
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
created: '2020-08-06T17:27:15Z'
decision: approved
decision_rationale: null
proposed_transfer:
ach_class: ppd
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
type: credit
user:
legal_name: Foo Bar
phone_number: 123-456-7890
email_address: user@plaid.com
address:
street: 100 Market Street
city: San Francisco
region: California
postal_code: '94103'
country: US
amount: '12.34'
network: ach
origination_account_id: 0123-4567-8901-2345-67890123
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: |-
Use the `/transfer/authorization/create` endpoint to determine transfer failure risk.
In Plaid's sandbox environment the decisions will be returned as follows:
- To approve a transfer, make an authorization request with an `amount` less than the available balance in the account.
- To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
- To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
- To permit a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits).
- To permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required).
All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferAuthorizationCreateRequest'
/transfer/create:
post:
summary: Create a transfer
tags:
- plaid
externalDocs:
url: /transfer/reference#transfercreate
operationId: transferCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferCreateResponse'
examples:
example-1:
value:
transfer:
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
ach_class: ppd
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
type: credit
user:
legal_name: Foo Bar
phone_number: 123-456-7890
email_address: user@plaid.com
address:
street: 100 Market Street
city: San Francisco
region: California
postal_code: '94103'
country: US
amount: '12.34'
description: A description of the transfer
created: '2020-08-06T17:27:15Z'
status: pending
network: ach
cancellable: true
failure_reason: null
metadata:
key1: value1
key2: value2
origination_account_id: 0123-4567-8901-2345-67890123
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/transfer/create` endpoint to initiate a new transfer.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferCreateRequest'
/bank_transfer/create:
post:
summary: Create a bank transfer
tags:
- plaid
externalDocs:
url: /api/products#bank_transfercreate
operationId: bankTransferCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferCreateResponse'
examples:
example-1:
value:
bank_transfer:
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
cancellable: true
created: '2020-08-06T17:27:15Z'
custom_tag: my tag
description: Testing2
direction: outbound
failure_reason: null
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
iso_currency_code: USD
metadata:
key1: value1
key2: value2
network: ach
origination_account_id: 11111111-1111-1111-1111-111111111111
status: pending
type: credit
user:
email_address: plaid@plaid.com
legal_name: John Smith
routing_number: '111111111'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferCreateRequest'
/transfer/list:
post:
summary: List transfers
tags:
- plaid
externalDocs:
url: /transfer/reference#transferlist
operationId: transferList
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferListResponse'
examples:
example-1:
value:
transfers:
- account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
cancellable: true
created: '2020-08-06T17:27:15Z'
description: Testing2
failure_reason:
ach_return_code: R13
description: Invalid ACH routing number
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
metadata:
key1: value1
key2: value2
network: ach
origination_account_id: 11111111-1111-1111-1111-111111111111
status: pending
type: credit
user:
email_address: plaid@plaid.com
legal_name: John Smith
phone_number: null
address: null
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: |
Use the `/transfer/list` endpoint 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.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferListRequest'
/bank_transfer/list:
post:
summary: List bank transfers
tags:
- plaid
externalDocs:
url: /api/products#bank_transferlist
operationId: bankTransferList
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferListResponse'
examples:
example-1:
value:
bank_transfers:
- account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
cancellable: true
created: '2020-08-06T17:27:15Z'
custom_tag: my tag
description: Testing2
direction: outbound
failure_reason:
ach_return_code: R13
description: Invalid ACH routing number
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
iso_currency_code: USD
metadata:
key1: value1
key2: value2
network: ach
origination_account_id: 11111111-1111-1111-1111-111111111111
status: pending
type: credit
user:
email_address: plaid@plaid.com
legal_name: John Smith
routing_number: '111111111'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: |
Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferListRequest'
/transfer/cancel:
post:
summary: Cancel a transfer
tags:
- plaid
externalDocs:
url: /transfer/reference#transfercancel
operationId: transferCancel
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferCancelResponse'
examples:
example-1:
value:
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/transfer/get` is `true`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferCancelRequest'
/bank_transfer/cancel:
post:
summary: Cancel a bank transfer
tags:
- plaid
externalDocs:
url: /api/products#bank_transfercancel
operationId: bankTransferCancel
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferCancelResponse'
examples:
example-1:
value:
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferCancelRequest'
/transfer/event/list:
post:
summary: List transfer events
tags:
- plaid
externalDocs:
url: /transfer/reference#transfereventlist
operationId: transferEventList
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferEventListResponse'
examples:
example-1:
value:
transfer_events:
- account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
transfer_amount: '12.34'
transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
transfer_type: credit
event_id: 1
event_type: posted
failure_reason: null
origination_account_id: null
timestamp: '2020-08-06T17:27:15Z'
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferEventListRequest'
/bank_transfer/event/list:
post:
summary: List bank transfer events
tags:
- plaid
externalDocs:
url: /api/products#bank_transfereventlist
operationId: bankTransferEventList
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferEventListResponse'
examples:
example-1:
value:
bank_transfer_events:
- account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
bank_transfer_amount: '12.34'
bank_transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
bank_transfer_iso_currency_code: USD
bank_transfer_type: credit
direction: outbound
event_id: 1
event_type: receiver_pending
failure_reason: null
origination_account_id: null
receiver_details:
available_balance: positive
timestamp: '2020-08-06T17:27:15Z'
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferEventListRequest'
/transfer/event/sync:
post:
summary: Sync transfer events
tags:
- plaid
externalDocs:
url: /transfer/reference#transfereventsync
operationId: transferEventSync
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferEventSyncResponse'
examples:
example-1:
value:
transfer_events:
- account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
transfer_amount: '12.34'
transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
transfer_type: credit
event_id: 1
event_type: pending
failure_reason: null
origination_account_id: null
timestamp: '2020-08-06T17:27:15Z'
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferEventSyncRequest'
description: '`/transfer/event/sync` 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.'
/bank_transfer/event/sync:
post:
summary: Sync bank transfer events
tags:
- plaid
externalDocs:
url: /api/products#bank_transfereventsync
operationId: bankTransferEventSync
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferEventSyncResponse'
examples:
example-1:
value:
bank_transfer_events:
- account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
bank_transfer_amount: '12.34'
bank_transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
bank_transfer_iso_currency_code: USD
bank_transfer_type: credit
direction: outbound
event_id: 1
event_type: pending
failure_reason: null
origination_account_id: null
receiver_details: null
timestamp: '2020-08-06T17:27:15Z'
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferEventSyncRequest'
description: '`/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.'
/transfer/sweep/get:
post:
summary: Retrieve a sweep
tags:
- plaid
externalDocs:
url: /transfer/reference#transfersweepget
operationId: transferSweepGet
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TransferSweepGetResponse'
examples:
example-1:
value:
sweep:
id: d5394a4d-0b04-4a02-9f4a-7ca5c0f52f9d
created_at: '2020-08-06T17:27:15Z'
amount: '12.34'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferSweepGetRequest'
examples: {}
parameters: []
/bank_transfer/sweep/get:
post:
summary: Retrieve a sweep
tags:
- plaid
externalDocs:
url: /api/products#bank_transfersweepget
operationId: bankTransferSweepGet
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferSweepGetResponse'
examples:
example-1:
value:
sweep:
id: d5394a4d-0b04-4a02-9f4a-7ca5c0f52f9d
transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
created_at: '2020-08-06T17:27:15Z'
amount: '12.34'
iso_currency_code: USD
sweep_account:
account_number: '123456789'
routing_number: '111111111'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferSweepGetRequest'
examples: {}
parameters: []
/transfer/sweep/list:
post:
summary: List sweeps
tags:
- plaid
externalDocs:
url: /transfer/reference#transfersweeplist
operationId: transferSweepList
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/TransferSweepListResponse'
examples:
example-1:
value:
sweeps:
- id: d5394a4d-0b04-4a02-9f4a-7ca5c0f52f9d
created_at: '2020-08-06T17:27:15Z'
amount: '-12.34'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferSweepListRequest'
examples: {}
parameters: []
/bank_transfer/sweep/list:
post:
summary: List sweeps
tags:
- plaid
externalDocs:
url: /api/products#bank_transfersweeplist
operationId: bankTransferSweepList
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferSweepListResponse'
examples:
example-1:
value:
sweeps:
- id: d5394a4d-0b04-4a02-9f4a-7ca5c0f52f9d
transfer_id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
created_at: '2020-08-06T17:27:15Z'
amount: '12.34'
iso_currency_code: USD
sweep_account:
account_number: '123456789'
routing_number: '111111111'
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferSweepListRequest'
examples: {}
parameters: []
/bank_transfer/balance/get:
post:
summary: Get balance of your Bank Transfer account
tags:
- plaid
externalDocs:
url: /api/products#bank_transferbalanceget
operationId: bankTransferBalanceGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferBalanceGetResponse'
examples:
example-1:
value:
balance:
available: '1721.70'
transactable: '721.70'
origination_account_id: 11111111-1111-1111-1111-111111111111
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: |-
Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created.
The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.
Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferBalanceGetRequest'
/bank_transfer/migrate_account:
post:
summary: Migrate account into Bank Transfers
tags:
- plaid
externalDocs:
url: /api/products#bank_transfermigrate_account
operationId: bankTransferMigrateAccount
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferMigrateAccountResponse'
examples:
example-1:
value:
access_token: access-sandbox-435beced-94e8-4df3-a181-1dde1cfa19f0
account_id: zvyDgbeeDluZ43AJP6m5fAxDlgoZXDuoy5gjN
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 'As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BankTransferMigrateAccountRequest'
/transfer/intent/create:
post:
summary: Create a transfer intent object to invoke the Transfer UI
tags:
- plaid
externalDocs:
url: /transfer/reference#transferintentcreate
operationId: transferIntentCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferIntentCreateResponse'
examples:
example-1:
value:
transfer_intent:
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
created: '2020-08-06T17:27:15Z'
description: Desc
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
metadata:
key1: value1
key2: value2
mode: DISBURSEMENT
origination_account_id: 9853defc-e703-463d-86b1-dc0607a45359
status: PENDING
user:
address:
street: 100 Market Street
city: San Francisco
region: California
postal_code: '94103'
country: US
email_address: user@plaid.com
legal_name: Foo Bar
phone_number: 123-456-7890
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferIntentCreateRequest'
/transfer/intent/get:
post:
summary: Retrieve more information about a transfer intent
tags:
- plaid
externalDocs:
url: /transfer/reference#transferintentget
operationId: transferIntentGet
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TransferIntentGetResponse'
examples:
example-1:
value:
transfer_intent:
account_id: 6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B
ach_class: ppd
amount: '12.34'
authorization_decision: APPROVED
authorization_decision_rationale: null
created: '2020-08-06T17:27:15Z'
description: Desc
failure_reason: null
id: 460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9
metadata:
key1: value1
key2: value2
mode: DISBURSEMENT
origination_account_id: 9853defc-e703-463d-86b1-dc0607a45359
status: SUCCEEDED
transfer_id: 8945fedc-e703-463d-86b1-dc0607b55460
user:
address:
street: 100 Market Street
city: San Francisco
region: California
postal_code: '94103'
country: US
email_address: user@plaid.com
legal_name: Foo Bar
phone_number: 123-456-7890
request_id: saKrIBuEB9qJZno
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransferIntentGetRequest'
/sandbox/bank_transfer/simulate:
post:
summary: Simulate a bank transfer event in Sandbox
tags:
- plaid
externalDocs:
url: /api/sandbox/#sandboxbank_transfersimulate
operationId: sandboxBankTransferSimulate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxBankTransferSimulateResponse'
examples:
example-1:
value:
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 'Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxBankTransferSimulateRequest'
/sandbox/transfer/sweep/simulate:
post:
summary: Simulate creating a sweep for a set of transfers
tags:
- plaid
externalDocs:
url: /transfer/reference#sandboxtransfersweepsimulate
operationId: sandboxTransferSweepSimulate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxTransferSweepSimulateResponse'
examples:
example-1:
value:
sweep:
id: d5394a4d-0b04-4a02-9f4a-7ca5c0f52f9d
created_at: '2020-08-06T17:27:15Z'
amount: '12.34'
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxTransferSweepSimulateRequest'
/sandbox/transfer/simulate:
post:
summary: Simulate a transfer event in Sandbox
tags:
- plaid
externalDocs:
url: /transfer/reference#sandboxtransfersimulate
operationId: sandboxTransferSimulate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxTransferSimulateResponse'
examples:
example-1:
value:
request_id: mdqfuVxeoza6mhu
default:
description: Error response
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: 'Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SandboxTransferSimulateRequest'
/employers/search:
post:
tags:
- plaid
externalDocs:
url: /api/employers/#employerssearch
operationId: employersSearch
summary: Search employer database
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/EmployersSearchResponse'
x-examples:
example-1:
value:
employers:
- name: Plaid Inc.
address:
city: San Francisco
country: US
postal_code: '94103'
region: CA
street: 1098 Harrison St
confidence_score: 1
employer_id: emp_1
request_id: ixTBLZGvhD4NnmB
description: |-
`/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow.
The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/EmployersSearchRequest'
/income/verification/create:
post:
summary: (Deprecated) Create an income verification instance
tags:
- plaid
deprecated: true
externalDocs:
url: /api/products/#incomeverificationcreate
operationId: incomeVerificationCreate
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/IncomeVerificationCreateResponse'
examples:
@MarwanRefaat
Copy link
Author

Spectral Errors and Warnings:Plaid-OpenAPI-Specification-Spectral-Errors
Plaid-OpenAPI-Specification-Spectral-Warnings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment