Transfer

transferEventSync

POST
/transfer/event/sync

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

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 /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 transfer events to return.

Formatint32
Range1 <= value <= 25
Default25

Response Body

application/json

application/json

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