Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Payment Balances

Retrieve Balance

Retrieve the details of the specific individual currency account balance

get/v2/payment/balances/{currency}

Path parameters

currencystring required
Example:SGD

Currency code for the balance query

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring uuid

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Response

Balance retrieved successfully

balance_idstring required

Account balance ID

currencystring iso-4217 required

Currency of the account balance

available_balancestring required

Current available balance

payable_balancestring required

Payable account balance

pending_balancestring required

Pending balance

reserved_balancestring required

Reserved balance

margin_balancestring required

Margin balance

frozen_balancestring required

Frozen funds

Example response

{
  "balance_id": "4a2dd9f0-bfe9-432b-be2e-4d5af5d0b448",
  "currency": "SGD",
  "available_balance": "1000.00",
  "payable_balance": "950.00",
  "pending_balance": "50.00",
  "reserved_balance": "0.00",
  "margin_balance": "0.00",
  "frozen_balance": "0.00"
}