Account Programs

Retrieve account program balance

Changed on

Returns the aggregated available balance of all accounts under the account program.

get/v1/account_programs/{id}/balance

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/account_programs/{id}/balance
  • Auth
    HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440002

Unique identifier of the account program.

Query parameters

as_ofstring date-time
Example:2026-01-15T10:40:00Z

ISO 8601 UTC timestamp to retrieve balance at. Must be at least 5 minutes in the past.

Response

Account program balance snapshot

idstring uuid required

Unique identifier of the account program.

type'account_program_balance' required

Resource type discriminator.

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

ISO 4217 currency code.

as_ofstring date-time required

ISO 8601 UTC timestamp when this balance snapshot was produced.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440002",
  "amount": {
    "available": "100.50",
    "pending": "100.50"
  },
  "currency": "USD",
  "as_of": "2026-01-15T10:40:00Z"
}

Changes