跳转到主要内容
GET
List Payouts

授权

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

payout_status
enum<string>

该 payout 的状态 该 payout 的状态。

  • READY_TO_SEND:payout 已通过校验,准备处理。
  • PENDING:payout 正在由系统处理中。
  • REJECTED:payout 因未满足校验或合规要求而被拒绝。
  • FAILED:payout 处理过程中发生错误,无法完成。
  • COMPLETED:payout 已成功处理,资金已转出。
可用选项:
READY_TO_SEND,
PENDING,
REJECTED,
FAILED,
COMPLETED
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"

响应

200 - application/json

OK —— 成功获取 payout 列表。

total_pages
integer

可用条目的总页数。

示例:

10

total_items
integer

可用条目的总数。

示例:

105

data
object[]