跳转到主要内容
GET
Retrieve a PaymentAttempt

授权

x-auth-token
string
header
必填

UQPay 提供的登录 API Token。

请求头

x-client-id
string
必填

UQPAY 生成的 API 客户端 ID

路径参数

id
string
必填

要查询的 PaymentAttempt ID

示例:

"PA1234567890123456789"

响应

200 - application/json

成功获取 PaymentAttempt 详情

attempt_id
string
必填

该 PaymentAttempt 的唯一标识。

示例:

"24fc62b4-90d1-42e3-96ab-dd54ccc648b3"

amount
string
必填

该 PaymentAttempt 的金额。

示例:

"9.98"

currency
string
必填

三位币种代码

示例:

"SGD"

captured_amount
string

已请款金额。

示例:

"0.00"

refunded_amount
string

已退款金额。

示例:

"0.00"

create_time
string<date/time>

该 PaymentAttempt 的创建时间。

示例:

"2025-03-21T17:17:32+08:00"

update_time
string<date/time>

该 PaymentAttempt 最近一次更新或操作的时间。

示例:

"2025-03-21T17:17:32+08:00"

complete_time
string<date/time>

该 PaymentAttempt 的完成时间。

示例:

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

cancellation_reason
string

取消该 PaymentIntent 的原因。

示例:

"Order cancelled"

auth_code
string

授权成功后由发卡行返回的授权码。

示例:

"A12B3C"

arn
string

收单参考号(ARN)。一个 23 位标识,用于跨机构对账和拒付追踪。

示例:

"74537604221222132710572"

rrn
string

检索参考号(RRN)。一个 12 位标识,用于交易查询和客服查询。

示例:

"123456789012"

advice_code
enum<string>

发卡行建议码,指示拒绝后的推荐操作。帮助商户实施智能重试策略。

  • 01:新的尝试可能成功。建议重试。
  • 02:请勿重试。请尝试其他支付方式。
  • 03:请勿重试。持卡人应联系其发卡行。
  • 21:取消所有待处理的授权。卡片可能已泄露。
  • 85:请勿重试。发卡行不会批准此类交易。
可用选项:
01,
02,
03,
21,
85
示例:

"01"

authentication_data
object

该 PaymentAttempt 的认证与验证数据。

payment_method
card · object

该 PaymentAttempt 所使用的支付方式详情。

failure_code
string

PaymentAttempt 失败码。可能的取值见 Error Code Reference.payment_error 部分。

示例:

""

attempt_status
enum<string>

该 PaymentAttempt 的状态。

  • INITIATED:已根据初始请求创建 PaymentAttempt。
  • AUTHENTICATION_REDIRECTED:等待客户完成身份验证,例如 3D Secure 或扫描二维码。
  • PENDING_AUTHORIZATION:已收到授权请求,正在等待支付渠道的最终决定。
  • AUTHORIZED:授权已成功完成。将根据配置自动或手动请款。
  • CAPTURE_REQUESTED:请款请求已成功提交,支付视为完成。
  • SETTLED:资金已从支付渠道结算并由 UQPAY 收到。
  • SUCCEEDED:UQPAY 已将资金结算至你的钱包。
  • CANCELLED:PaymentAttempt 已取消。若有已授权资金,将退回给客户。
  • EXPIRED:PaymentAttempt 未在允许的时间窗口内完成,已过期。
  • FAILED:PaymentAttempt 已失败。请创建新的 PaymentAttempt 重试。
可用选项:
INITIATED,
AUTHENTICATION_REDIRECTED,
PENDING_AUTHORIZATION,
AUTHORIZED,
CAPTURE_REQUESTED,
SETTLED,
SUCCEEDED,
CANCELLED,
EXPIRED,
FAILED
示例:

"INITIATED"