plaid

Sync transfer events

Changed on

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

post/transfer/event/sync

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/transfer/event/sync
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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_idinteger required

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

countinteger nullable

The maximum number of transfer events to return.

Response

OK

has_moreboolean required

Whether there are more events to be pulled from the endpoint that have not already been returned

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e07a869352e8Revision changes
    • warning

      added the new adjustment enum value to the // response property for the response status