Accounts

Retrieve account balance

Changed on

Retrieves the available balance for an account.

get/v1/accounts/{id}/balance

Request

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

Path parameters

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

Unique identifier of the account.

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

The account balance resource

type'account_balance' required

Resource type discriminator.

account_idstring uuid required

Unique identifier of the account.

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

Currency code (ISO 4217 or crypto).

as_ofstring date-time required

ISO 8601 UTC timestamp when the balance was retrieved.

Example response

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

Changes

  • f7ded6c181abRevision changes
    • info

      endpoint added

  • 3d21138daf4cRevision changes
    • info

      removed the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$ from the path request parameter id

    • info

      the response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$ was removed for the status

    • info

      the response's property pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ was removed for the status