Skip to main content
POST
/
v1
/
issuing
/
balances
Retrieve Issuing Balance
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/balances \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "currency": "USD"
}
'
{
  "balance_id": "72970a7c-7921-431c-b95f-3438724ba16f",
  "currency": "USD",
  "available_balance": 5000.25,
  "margin_balance": 10000,
  "frozen_balance": 2353.25,
  "create_time": "2024-03-21T17:17:32+08:00",
  "last_trade_time": "2024-03-21T17:17:32+08:00",
  "balance_status": "ACTIVE"
}

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.

Body

application/json
​
currency
string
required

Currency of the account balance.

Example:

"USD"

Response

Balances returned successfully.

​
balance_id
string
required

The account balance id.

Example:

"72970a7c-7921-431c-b95f-3438724ba16f"

​
currency
string
required

Currency of the account balance.

Example:

"USD"

​
available_balance
number
required

Available balance.

Example:

5000.25

​
margin_balance
number
required

Margin balance.

Example:

10000

​
frozen_balance
number
required

Frozen balance.

Example:

2353.25

​
create_time
string
required

Create time at which the object was created.

Example:

"2024-03-21T17:17:32+08:00"

​
last_trade_time
string
required

The last trade time at which the object was updated.

Example:

"2024-03-21T17:17:32+08:00"

​
balance_status
enum<string>
required

The balance status of the account.

Available options:
ACTIVE,
PENDING,
PROCESSING,
CLOSED
Example:

"ACTIVE"