跳转到主要内容
GET
List Balances Transactions

授权

x-auth-token
string
header
必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设为 account_id,可通过查询关联账户列表获取。如果省略或留空,请求将使用主账户执行。 更多信息参见关联账户

查询参数

page_size
integer
必填

每页返回的最大条目数。必须在 10 到 100 之间(含)。

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

10

page_number
integer
必填

用于获取特定一组条目的页码。必须 大于等于 1

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

1

start_time
string

created_time 的开始时间,ISO8601 格式(含)。

示例:

"2024-03-01T00:00:00+08:00"

end_time
string

created_time 的结束时间,ISO8601 格式(含)。

示例:

"2024-03-01T00:00:00+08:00"

currency
string

指定获取交易所用的币种。币种代码遵循 ISO 4217 标准。

示例:

"USD"

transaction_type
enum<string>

交易类型。

  • ALL:包括系统中所有类型的资金交易。
  • PAYIN:从外部来源收到的入款。
  • DEPOSIT:通过银行转账或其他方式直接存入账户的资金。
  • PAYOUT:发往外部受益人的出款。
  • TRANSFER:内部账户之间的资金划转。
  • CONVERSION:不同币种之间的换汇。
  • FEE:服务费或交易手续费。
  • REFUND:对先前付款或交易的退款。
  • ADJUSTMENT:对账户余额的人工或自动校正。
  • INVOICE:发票交易。
可用选项:
ALL,
PAYIN,
DEPOSIT,
PAYOUT,
TRANSFER,
CONVERSION,
FEE,
REFUND,
ADJUSTMENT,
INVOICE
示例:

"PAYOUT"

transaction_status
enum<string>

交易状态。

  • ALL:表示所有可能的交易状态。
  • COMPLETED:交易已成功处理并完结。
  • PENDING:交易正在处理中,等待完成。
  • FAILED:交易因错误或被拒绝而无法完成。
可用选项:
ALL,
COMPLETED,
PENDING,
FAILED
示例:

"COMPLETED"

响应

200 - application/json

OK —— 余额交易返回成功。

total_pages
integer

可用条目的总页数。

示例:

10

total_items
integer

可用条目的总数。

示例:

105

data
object[]