跳转到主要内容
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"
}

Documentation Index

Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/llms.txt

Use this file to discover all available pages before exploring further.

授权

​
x-auth-token
string
header
必填

The API token for login provided by UQPay.

请求头

​
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>
必填

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.

路径参数

​
currency
string
必填

Currency code for the balance query

示例:

"SGD"

响应

200 - application/json

Balance retrieved successfully

​
balance_id
string
必填

Account balance ID

示例:

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

​
currency
string<iso-4217>
必填

Currency of the account balance

示例:

"SGD"

​
available_balance
string
必填

Current available balance

示例:

"1000.00"

​
payable_balance
string
必填

Payable account balance

示例:

"950.00"

​
pending_balance
string
必填

Pending balance

示例:

"50.00"

​
reserved_balance
string
必填

Reserved balance

示例:

"0.00"

​
margin_balance
string
必填

Margin balance

示例:

"0.00"

​
frozen_balance
string
必填

Frozen funds

示例:

"0.00"