Skip to main content

Balances

GET

{BASE_URL}/balances

Returns cash balances for a Hong Kong account in the account currency (HKD). Amounts are decimal strings with trailing zeros removed.

By default, values come from Atomic Vaults' stored ledger for the account.

With end_customer_id, the response is the end customer's sub-ledger under the omnibus account. Only cash_available and cash_withheld_for_buys are populated; the other fields are "0". An unknown ID returns 400 DataRetrieval_Error.

With source=whale (omnibus requests only; ignored when end_customer_id is set), cash_available is GigaMoney Whale's total available cash, summed across the Whale accounts mapped to account_number and expressed in currency. Every other field is "0". If the account has no Whale mapping, the default ledger response is returned. Whale failures return 502.

Request​

Responses​

OK