版本:202201
查询支付订单详情
GET/openapi/2024-07/shoplazza-payment/payment-orders/:id
根据唯一标识返回单个支付订单的详细信息。
请求
Path参数
id string必填
支付订单 ID。
响应
- 200
- 500
OK
- application/json
- 数据结构
- 示例
数据结构
- succeeded: 支付成功,资金已确认到账。
- failed: 支付失败,资金未被处理。
- requires_action: 需要额外操作才能完成支付(如 3D Secure 验证)。
- init: 支付订单已创建但尚未处理。
- canceled: 支付订单已取消,资金未被处理或已退回。
- processing: 支付处理中,最终结果待确认。
codestring
error code
messagestring
error message
data object
Request: Retrieve payment order
payment_order object
Payment order details
idstring
支付订单 ID。
fee_details object
此支付订单的交易费用明细。
trans_fee_amountstring
Acquiring fee amount
fee_currencystring
Fee currency
foreign_settlement_feestring
Foreign settlement fee
created_atstring
支付订单的创建时间(如 2018-11-02T12:30:10Z)。
finished_atstring
支付订单完成的时间(如 2018-11-02T12:30:10Z)。
payment_statusstring
订单当前的支付状态。
payment_methodstring
支付订单所使用的支付方式(如信用卡、PayPal)。
card_brandstring
支付所使用信用卡的品牌(如 Visa、Mastercard)。
pay_currencystring
消费者实际支付所使用的币种代码(如 USD、EUR)。
pay_amountstring
Transaction amount in the original currency
converted_amountstring
支付金额折算为店铺基础币种后的数值。
reserve_amountstring
预留金额。
order_idstring
与此次支付关联的订单标识符。
{
"code": "string",
"message": "string",
"data": {
"payment_order": {
"id": "string",
"fee_details": {
"trans_fee_amount": "string",
"fee_currency": "string",
"foreign_settlement_fee": "string"
},
"created_at": "string",
"finished_at": "string",
"payment_status": "string",
"payment_method": "string",
"card_brand": "string",
"pay_currency": "string",
"pay_amount": "string",
"converted_amount": "string",
"reserve_amount": "string",
"order_id": "string"
}
}
}
UnknownError
- application/json
- 数据结构
- 示例
- 示例
数据结构
codestring
error code
messagestring
error message
{
"code": "string",
"message": "string"
}
{
"code": "InvalidParameter",
"message": "Unknown error, please contact shoplazza technical support to resolve the issue."
}