bankTransferGet
The /bank_transfer/get fetches information about the bank transfer corresponding to the given bank_transfer_id.
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/get
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.
Plaid’s unique identifier for a bank transfer.
Response Body
application/json
application/json
curl -X POST "https://example.com/bank_transfer/get" \ -H "Content-Type: application/json" \ -d '{ "bank_transfer_id": "string" }'{ "bank_transfer": { "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"}bankTransferEventList POST
Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
bankTransferBalanceGet POST
Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.