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

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 endpoint. 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.

请求体

application/json
​
currency
string
必填

Currency of the account balance.

示例:

"USD"

响应

200 - application/json

Balances returned successfully.

​
balance_id
string
必填

The account balance id.

示例:

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

​
currency
string
必填

Currency of the account balance.

示例:

"USD"

​
available_balance
number
必填

Available balance.

示例:

5000.25

​
margin_balance
number
必填

Margin balance.

示例:

10000

​
frozen_balance
number
必填

Frozen balance.

示例:

2353.25

​
create_time
string
必填

Create time at which the object was created.

示例:

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

​
last_trade_time
string
必填

The last trade time at which the object was updated.

示例:

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

​
balance_status
enum<string>
必填

The balance status of the account.

可用选项:
ACTIVE,
PENDING,
PROCESSING,
CLOSED
示例:

"ACTIVE"