Sync bank transfer events

POST /bank_transfer/event/sync

/bank_transfer/event/sync allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific event_id. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see micro-deposit events.

Request Body

Required

Defines the request schema for /bank_transfer/event/sync

Parameters

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
required, integer
The latest (largest) event_id fetched via the sync endpoint, or 0 initially.
count
integer
The maximum number of bank transfer events to return.

Response

Defines the response schema for /bank_transfer/event/sync

Response Properties

bank_transfer_events
required, array[object]
event_id
required, integer
Plaid’s unique identifier for this event. IDs are sequential unsigned 64-bit integers.
timestamp
required, string
The datetime when this event occurred. This will be of the form 2006-01-02T15:04:05Z.
event_type
required, string
The type of event that this bank transfer represents. pending: A new transfer was created; it is in the pending state. cancelled: The transfer was cancelled by the client. failed: The transfer failed, no funds were moved. posted: The transfer has been successfully submitted to the payment network. reversed: A posted transfer was reversed.
account_id
required, string
The account ID associated with the bank transfer.
bank_transfer_id
required, string
Plaid’s unique identifier for a bank transfer.
origination_account_id
required, string
The ID of the origination account that this balance belongs to.
bank_transfer_type
required, string
The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into the origination account; a credit indicates a transfer of money out of the origination account.
bank_transfer_amount
required, string
The bank transfer amount.
bank_transfer_iso_currency_code
required, string
The currency of the bank transfer amount.
failure_reason
required, object
The failure reason if the type of this transfer is "failed" or "reversed". Null value otherwise.
ach_return_code
string
The ACH return code, e.g. R01. A return code will be provided if and only if the transfer status is reversed. For a full listing of ACH return codes, see Bank Transfers errors.
description
string
A human-readable description of the reason for the failure or reversal.
direction
required, string
Indicates the direction of the transfer: outbound for API-initiated transfers, or inbound for payments received by the FBO account.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.