跳转到主要内容
GET
List all PaymentAttempts

授权

x-auth-token
string
header
必填

UQPay 提供的登录 API Token。

请求头

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_id
string

按 PaymentIntent ID 筛选 PaymentAttempt

示例:

"PI1234567890123456789"

attempt_status
enum<string>

按状态筛选 PaymentAttempt。

  • INITIATED:根据初始请求创建。
  • AUTHENTICATION_REDIRECTED:等待客户身份验证。
  • PENDING_AUTHORIZATION:等待支付渠道的最终决定。
  • AUTHORIZED:授权成功完成。
  • CAPTURE_REQUESTED:已提交请款,支付视为完成。
  • SETTLED:资金已由支付渠道结算并由 UQPAY 收到。
  • SUCCEEDED:UQPAY 已将资金结算到你的钱包。
  • CANCELLED:PaymentAttempt 已取消。
  • EXPIRED:未在允许的时间窗口内完成。
  • FAILED:PaymentAttempt 失败。
可用选项:
INITIATED,
AUTHENTICATION_REDIRECTED,
PENDING_AUTHORIZATION,
AUTHORIZED,
CAPTURE_REQUESTED,
SETTLED,
SUCCEEDED,
CANCELLED,
EXPIRED,
FAILED
示例:

"INITIATED"

响应

200 - application/json

成功获取 PaymentAttempt 列表

total_pages
integer

可用条目的总页数。

示例:

10

total_items
integer

可用条目的总数。

示例:

105

data
object[]