Bank Transfer

bankTransferBalanceGet

POST
/bank_transfer/balance/get

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.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

Defines the request schema for /bank_transfer/balance/get

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.

origination_account_id?|

If multiple origination accounts are available, origination_account_id must be used to specify the account for which balance will be returned.

Response Body

application/json

application/json

curl -X POST "https://example.com/bank_transfer/balance/get" \  -H "Content-Type: application/json" \  -d '{}'
{  "balance": {    "available": "1721.70",    "transactable": "721.70"  },  "origination_account_id": "11111111-1111-1111-1111-111111111111",  "request_id": "mdqfuVxeoza6mhu"}