跳转到主要内容
GET
List all Payouts

授权

x-auth-token
string
header
必填

UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起该请求。应设置为 account_id,可通过 List Connected Accounts 获取。若省略或为空,则使用主账户执行请求。 更多信息见 Connected Accounts

x-idempotency-key
string<uuid>
必填

用于保持操作幂等性的唯一标识符(UUID),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。

查询参数

page_number
integer
必填

用于获取下一批条目的页码,取值必须大于 1。

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

1

page_size
integer
必填

每页返回的最大条目数,取值范围 1 - 100。

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

10

start_time
string

出款创建起始日期(含)。日期格式 YYYY-MM-DD 表示当天起始(00:00:00)。

示例:

"2025-07-01"

end_time
string

出款创建结束日期(含)。日期格式 YYYY-MM-DD 表示当天结束(23:59:59)。

示例:

"2025-07-31"

payout_status
enum<string>

出款状态筛选 出款状态枚举。

  • INITIATED:出款已发起。
  • PROCESSING:出款正在处理中(银行处理中)。
  • COMPLETED:出款已成功完成。
  • FAILED:出款失败。
  • FAILED_REFUNDED:出款失败,资金已退回。
可用选项:
INITIATED,
PROCESSING,
COMPLETED,
FAILED,
FAILED_REFUNDED
示例:

"INITIATED"

响应

200 - application/json

成功获取出款列表

total_pages
integer
必填

可用条目的总页数。

示例:

10

total_items
integer
必填

可用条目的总数。

示例:

105

data
object[]
必填

出款记录列表。