List bank transfer events

POST /bank_transfer/event/list

Use the /bank_transfer/event/list endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. 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/list

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.
start_date
string
The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)
end_date
string
The end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)
bank_transfer_id
string
Plaid’s unique identifier for a bank transfer.
account_id
string
The account ID to get events for all transactions to/from an account.
bank_transfer_type
string
The type of bank transfer. This will be either debit or credit. A debit indicates a transfer of money into your origination account; a credit indicates a transfer of money out of your origination account.
event_types
array[string]
Filter events by event type.
count
integer
The maximum number of bank transfer events to return. If the number of events matching the above parameters is greater than count, the most recent events will be returned.
offset
integer
The offset into the list of bank transfer events. When count=25 and offset=0, the first 25 events will be returned. When count=25 and offset=25, the next 25 bank transfer events will be returned.
origination_account_id
string
The origination account ID to get events for transfers from a specific origination account.
direction
string
Indicates the direction of the transfer: outbound: for API-initiated transfers inbound: for payments received by the FBO account.

Response

Defines the response schema for /bank_transfer/event/list

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.