Skip to main content
GET
/
api
/
v1
/
balances
curl 'https://api.sandbox.uqpay.org/api/v1/balances?page_num=1&page_size=100' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "total_item": 2,
        "total_page": 1,
        "item_list": [
            {
                "balance_id": "b8241d83-b849-49c5-ac20-c2c311953577",
                "balance_name": "1",
                "balance_currency": "SGD",
                "available_balance": "742",
                "pending_balance": "0",
                "reserved_balance": "0",
                "margin_balance": "0",
                "frozen_balance": "0",
                "create_time": "2023-09-07T13:57:32+08:00"
            },
            {
                "balance_id": "4cf219c6-e023-4222-a123-8e3dd1643274",
                "balance_name": "1",
                "balance_currency": "USD",
                "available_balance": "0",
                "pending_balance": "0",
                "reserved_balance": "0",
                "margin_balance": "0",
                "frozen_balance": "0",
                "create_time": "2023-09-06T10:21:41+08:00"
            }
        ]
    }
}

Documentation Index

Fetch the complete documentation index at: https://docs.uqpay.org/llms.txt

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

​
x-client-id
string
required
x-client-id.
​
x-auth-token
string
required
Bearer YOUR_TOKEN_HERE.

​
Parameters

​
page_num
number
required
Page number, starts from 1.
​
page_size
number
required
Number of results per page.
Maximum 100
​
currency
string
Filter on currency of the balance.
Three-letter ISO 4217 currency code.
​
status
string
Filter on status of the balance.
One of all, active, closed
​
name
string
Fuzzy search by name of the balance.

​
Response

​
code
number
Indicates whether the call was successful. 200 if successful, 400 if not.
​
message
string
Response Message. “Success” if successful, others not.
​
data
object
curl 'https://api.sandbox.uqpay.org/api/v1/balances?page_num=1&page_size=100' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "total_item": 2,
        "total_page": 1,
        "item_list": [
            {
                "balance_id": "b8241d83-b849-49c5-ac20-c2c311953577",
                "balance_name": "1",
                "balance_currency": "SGD",
                "available_balance": "742",
                "pending_balance": "0",
                "reserved_balance": "0",
                "margin_balance": "0",
                "frozen_balance": "0",
                "create_time": "2023-09-07T13:57:32+08:00"
            },
            {
                "balance_id": "4cf219c6-e023-4222-a123-8e3dd1643274",
                "balance_name": "1",
                "balance_currency": "USD",
                "available_balance": "0",
                "pending_balance": "0",
                "reserved_balance": "0",
                "margin_balance": "0",
                "frozen_balance": "0",
                "create_time": "2023-09-06T10:21:41+08:00"
            }
        ]
    }
}