Sign in
Account Programs

Retrieve account program balance

Returns the aggregated available balance for all virtual accounts under the account program.

get/v1/account_programs/{id}/balance

Path parameters

idstring uuid required

Unique identifier of the account program.

Response

Account program balance snapshot

idstring uuid required

Unique identifier of the account program.

type'account_program_balance' required

Resource type discriminator.

amountstring required

Total available balance as a string decimal (e.g. "100.50").

currency'EUR' | 'GBP' | 'USD' required

ISO 4217 currency code for the balance.

as_ofstring date-time required

ISO 8601 UTC timestamp when this balance snapshot was produced.

Changes

Changed in 1 of the 30 revisions of this API.1