跳转到主要内容
GET
/
v2
/
payment
/
balances
List Balances
curl --request GET \
  --url https://api-sandbox.uqpaytech.com/api/v2/payment/balances \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>'
{
  "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"
    }
  ]
}

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.

查询参数

​
page_number
integer
必填

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

必填范围: x >= 1
示例:

1

​
page_size
integer
必填

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

必填范围: 1 <= x <= 100
示例:

10

响应

200 - application/json

List of balances retrieved successfully

​
total_pages
integer
必填

The total pages of available items.

示例:

10

​
total_items
integer
必填

The total counts of available items.

示例:

105

​
data
object[]
必填

List of balance records.