跳转到主要内容
GET
List all PaymentIntents

授权

x-auth-token
string
header
必填

UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

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

x-client-id
string
必填

UQPAY 生成的 API 客户端 ID

查询参数

page_size
integer
必填

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

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

10

page_number
integer
必填

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

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

1

payment_intent_status
enum<string>

PaymentIntent 的状态。 该 PaymentIntent 的状态。

  • REQUIRES_PAYMENT_METHOD:PaymentIntent 正在等待确认请求。
  • REQUIRES_CUSTOMER_ACTION:PaymentIntent 正在等待客户进一步的认证操作,例如 3DS 验证和扫描二维码。请查看 next_action
  • REQUIRES_CAPTURE:PaymentIntent 正在等待你请款以完成支付。
  • PENDING:PaymentIntent 正在等待支付渠道返回最终结果,无需进一步操作。
  • SUCCEEDED:PaymentIntent 已成功,支付完成。
  • CANCELLED:PaymentIntent 已按你的请求取消,支付已关闭。
  • FAILED:PaymentIntent 已失败。
可用选项:
REQUIRES_PAYMENT_METHOD,
REQUIRES_CUSTOMER_ACTION,
REQUIRES_CAPTURE,
PENDING,
SUCCEEDED,
CANCELLED,
FAILED
start_time
string

用于按 create_time 筛选的起始时间(不含)。ISO 8601 格式。

示例:

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

end_time
string

用于按 create_time 筛选的结束时间(不含)。ISO 8601 格式。

示例:

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

响应

200 - application/json

成功获取 PaymentIntent 列表

total_pages
integer

可用条目的总页数。

示例:

10

total_items
integer

可用条目的总数。

示例:

105

data
object[]