Accounts

Retrieve account balance

Retrieves the available balance for an account.

get/v1/accounts/{id}/balance

Path parameters

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

Unique identifier of the account.

Response

The account balance resource

type'account_balance' required

Resource type discriminator.

account_idstring uuid required

Unique identifier of the account.

amountstring required

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

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": "100.50",
  "currency": "EUR",
  "as_of": "2026-01-15T10:40:00Z"
}

Changes

Changed in 5 of the 38 revisions of this API.1410

    • 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

      request-parameter-pattern-removed

    • the account_id 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 200

      response-property-pattern-removed

    • the as_of 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 200

      response-property-pattern-removed

    • removed the BTC enum value from the currency response property for the response status 200

      response-property-enum-value-removed

    • removed the ETH enum value from the currency response property for the response status 200

      response-property-enum-value-removed

    • removed the POL enum value from the currency response property for the response status 200

      response-property-enum-value-removed

    • removed the SOL enum value from the currency response property for the response status 200

      response-property-enum-value-removed

    • added the new ETH enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • added the new POL enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • added the new SOL enum value to the currency response property for the response status 200

      response-property-enum-value-added

  • 74deb4d45f9f112See the full diff
    • added 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)$ to the path request parameter id

      request-parameter-pattern-added

    • added the new BTC enum value to the currency response property for the response status 200

      response-property-enum-value-added

    • the account_id 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 added for the status 200

      response-property-pattern-added

    • the as_of 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 added for the status 200

      response-property-pattern-added

    • endpoint added

      endpoint-added