Retrieve a refund
Payment Refunds
Retrieve a refund
按 ID 查询指定退款的详细信息
GET
Retrieve a refund
授权
UQPay 提供的登录 API Token。
请求头
UQPAY 生成的 API 客户端 ID
路径参数
要查询的退款 ID
示例:
"RF1234567890123456789"
响应
200 - application/json
成功获取退款详情
退款的唯一标识
示例:
"RF123456789"
已退款的 PaymentAttempt 的 ID
示例:
"PA123456789"
已退款的金额
示例:
"10.01"
三字母币种代码(ISO 4217)
示例:
"USD"
退款的当前状态。
INITIATED:退款已发起。PROCESSING:退款正在处理中。SUCCEEDED:退款已成功完成。FAILED:退款尝试失败。REVERSAL_INITIATED:退款的冲正已发起。REVERSAL_PROCESSING:退款的冲正正在处理中。REVERSAL_SUCCEEDED:退款的冲正已成功完成。
可用选项:
INITIATED, PROCESSING, SUCCEEDED, FAILED, REVERSAL_INITIATED, REVERSAL_PROCESSING, REVERSAL_SUCCEEDED 示例:
"SUCCEEDED"
该退款的创建时间。
示例:
"2024-03-01T00:00:00+08:00"
该退款最近一次更新或操作的时间。
示例:
"2024-03-01T00:00:00+08:00"
退款原因
Maximum string length:
100示例:
"Order 1234 has been returned"
与退款关联的附加元数据。用户自定义的键值对。
示例:

