bankTransferList
Use the /bank_transfer/list endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the count and offset query parameters to retrieve the desired bank transfers.
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/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-timeThe maximum number of bank transfers to return.
int321 <= value <= 2525The number of bank transfers to skip before returning results.
int320 <= value0Filter bank transfers to only those originated through the specified origination account.
Indicates the direction of the transfer: outbound for API-initiated transfers, or inbound for payments received by the FBO account.
Value in
- "outbound"
- "inbound"
Response Body
application/json
application/json
curl -X POST "https://example.com/bank_transfer/list" \ -H "Content-Type: application/json" \ -d '{}'{ "bank_transfers": [ { "account_id": "6qL6lWoQkAfNE3mB8Kk5tAnvpX81qefrvvl7B", "ach_class": "ppd", "amount": "12.34", "cancellable": true, "created": "2020-08-06T17:27:15Z", "custom_tag": "my tag", "description": "Testing2", "direction": "outbound", "failure_reason": { "ach_return_code": "R13", "description": "Invalid ACH routing number" }, "id": "460cbe92-2dcc-8eae-5ad6-b37d0ec90fd9", "iso_currency_code": "USD", "metadata": { "key1": "value1", "key2": "value2" }, "network": "ach", "origination_account_id": "11111111-1111-1111-1111-111111111111", "status": "pending", "type": "credit", "user": { "email_address": "plaid@plaid.com", "legal_name": "John Smith", "routing_number": "111111111" } } ], "request_id": "saKrIBuEB9qJZno"}bankTransferSweepGet POST
The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
bankTransferEventSync POST
`/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.