Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Payment Balances

List Balances

Retrieve lists of payment currency account balances

get/v2/payment/balances

Query parameters

page_numberinteger required
Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

page_sizeinteger required
Example:10

The maximum number of items to return per page. This number can be between 1 - 100

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

List of balances retrieved successfully

total_pagesinteger required

The total pages of available items.

total_itemsinteger required

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "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"
    }
  ]
}