Plaid Developer Portal
Plaid
HomeSDKsAPI ReferenceContext Plugin
Bank Transfer

bankTransferEventSync

POST
/bank_transfer/event/sync

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

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

Defines the request schema for /bank_transfer/event/sync

client_id?string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secret?string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

after_id*integer

The latest (largest) event_id fetched via the sync endpoint, or 0 initially.

Formatint32
Range0 <= value
count?|

The maximum number of bank transfer events to return.

Formatint32
Range1 <= value <= 25
Default25

Response Body

application/json

application/json

curl -X POST "https://example.com/bank_transfer/event/sync" \  -H "Content-Type: application/json" \  -d '{    "after_id": 0  }'
{  "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"}

bankTransferList POST

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.

bankTransferMigrateAccount POST

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.