Transfer Balance

API reference for Transfer balance

Balance
/transfer/balance/getRetrieve information about a balance held with Plaid

/transfer/balance/get

Retrieve a balance held with Plaid

Use the /transfer/balance/get endpoint to view a balance held with Plaid.

transfer/balance/get

Request fields and example

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.
type
string
The type of balance.
prefunded_rtp_credits - Your prefunded RTP credit balance with Plaid prefunded_ach_credits - Your prefunded ACH credit balance with Plaid

Possible values: prefunded_rtp_credits, prefunded_ach_credits
1const request: TransferBalanceGetRequest = {
2  type: 'prefunded_rtp_credits',
3};
4
5try {
6  const response = await client.transferBalanceGet(request);
7  const available_balance = response.data.balance.available;
8} catch (error) {
9  // handle error
10}
transfer/balance/get

Response fields and example

balance
object
Information about the balance held with Plaid.
available
string
The amount of this balance available for use (decimal string with two digits of precision e.g. "10.00").
current
string
The available balance, plus amount of pending funds that in processing (decimal string with two digits of precision e.g. "10.00").
type
string
The type of balance.
prefunded_rtp_credits - Your prefunded RTP credit balance with Plaid prefunded_ach_credits - Your prefunded ACH credit balance with Plaid

Possible values: prefunded_rtp_credits, prefunded_ach_credits
request_id
string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
1{
2  "balance": {
3    "available": "1721.70",
4    "type": "prefunded_rtp_credits"
5  },
6  "request_id": "saKrIBuEB9qJZno"
7}