Skip to main content
GET
/
v2
/
payment
/
balances
/
{currency}
Retrieve Balance
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment/balances/{currency} \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>'
{
  "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"
}

Authorizations

​
x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

​
x-on-behalf-of
string

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. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

​
x-idempotency-key
string<uuid>
required

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.

Path Parameters

​
currency
string
required

Currency code for the balance query

Example:

"SGD"

Response

Balance retrieved successfully

​
balance_id
string
required

Account balance ID

Example:

"4a2dd9f0-bfe9-432b-be2e-4d5af5d0b448"

​
currency
string<iso-4217>
required

Currency of the account balance

Example:

"SGD"

​
available_balance
string
required

Current available balance

Example:

"1000.00"

​
payable_balance
string
required

Payable account balance

Example:

"950.00"

​
pending_balance
string
required

Pending balance

Example:

"50.00"

​
reserved_balance
string
required

Reserved balance

Example:

"0.00"

​
margin_balance
string
required

Margin balance

Example:

"0.00"

​
frozen_balance
string
required

Frozen funds

Example:

"0.00"