Balances

Balances

Last updated: (timestamp)

Balances

balances

Methods

List balances

get/v1/balances

Get the balances for a program, business, or a given end-user account

Domain Types

Balance

Balanceobject

Balance

ShowShow

available_amountnumber

Funds available for spend in the currency's smallest unit (e.g., cents for USD)

createdstring

Date and time for when the balance was first created.

formatdate-time

currencystring

3-character alphabetic ISO 4217 code for the local currency of the balance.

financial_account_tokenstring

Globally unique identifier for the financial account that holds this balance.

formatuuid

financial_account_typeenum

Accepts one of the following: "ISSUING", "OPERATING", "RESERVE"

Type of financial account.

Hide ParametersShow Parameters

"ISSUING"

"OPERATING"

"RESERVE"

last_transaction_event_tokenstring

Globally unique identifier for the last financial transaction event that impacted this balance.

formatuuid

last_transaction_tokenstring

Globally unique identifier for the last financial transaction that impacted this balance.

formatuuid

pending_amountnumber

Funds not available for spend due to card authorizations or pending ACH release. Shown in the currency's smallest unit (e.g., cents for USD).

total_amountnumber

The sum of available and pending balance in the currency's smallest unit (e.g., cents for USD).

updatedstring

Date and time for when the balance was last updated.

formatdate-time