跳转到主要内容
GET
Get list of settlements

授权

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),确保同一操作重复执行不会产生意外影响或重复结果。它有助于在网络错误、重试或故障时保持数据一致性。

查询参数

payment_intent_id
string

PaymentIntent 的唯一 ID。

示例:

"PI1945730395043532800"

settlement_batch_id
string

结算批次的标识符。

示例:

"SB1947180993781698560"

settled_start_time
string

用于按 settlement_date 筛选的起始日期(含),格式为 YYYY-MM-DD。时间基于 UTC+8。

示例:'2025-07-01' 表示 settlement_date ≥ 2025-07-01T00:00:00(UTC+8)。

示例:

"2025-07-01"

settled_end_time
string

用于按 settlement_date 筛选的结束日期(含),格式为 YYYY-MM-DD。时间基于 UTC+8。

示例:'2025-07-31' 表示 settlement_date ≤ 2025-07-31T23:59:59(UTC+8)。

示例:

"2025-07-31"

page_number
integer
必填

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

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

1

page_size
integer
必填

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

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

10

响应

200 - application/json

成功获取结算列表

total_pages
integer

可用条目的总页数。

示例:

10

total_items
integer

可用条目的总数。

示例:

105

data
object[]