bankTransferEventList
Use the /bank_transfer/event/list endpoint to get a list of bank transfer events based on specified filter criteria.
Authorization
PLAID-CLIENT-ID PLAID-SECRET Plaid-Version In: header
In: header
In: header
Request Body
application/json
Defines the request schema for /bank_transfer/event/list
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.
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.
The start datetime of bank transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)
date-timeThe end datetime of bank transfers to list. This should be in RFC 3339 format (i.e. 2019-12-06T22:35:49Z)
date-timePlaid’s unique identifier for a bank transfer.
The account ID to get events for all transactions to/from an account.
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.
Value in
- "debit"
- "credit"
Filter events by event type.
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.
int321 <= value <= 2525The 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.
int320 <= value0The origination account ID to get events for transfers from a specific origination account.
Indicates the direction of the transfer: outbound: for API-initiated transfers
inbound: for payments received by the FBO account.
Value in
- "inbound"
- "outbound"
Response Body
application/json
application/json
curl -X POST "https://example.com/bank_transfer/event/list" \ -H "Content-Type: application/json" \ -d '{}'{ "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": "receiver_pending", "failure_reason": null, "origination_account_id": null, "receiver_details": { "available_balance": "positive" }, "timestamp": "2020-08-06T17:27:15Z" } ], "request_id": "mdqfuVxeoza6mhu"}