跳到主要内容

发起退款

发起指定尾派小包的退款请求。

端点: POST /api/shipments/{id}/refund

所需权限 (Scope): shipments:write

路径参数

参数类型必填描述
idstring要退款的尾派小包 ID。

响应规范

返回包装在 Result 中的 Shipment Refund 对象。

示例 JSON

{
"Data": {
"Status": "Refunded",
"TrackingNumber": "9200190327908701117139",
"Barcode": "420900019200190327908701117139",
"CurrencyCode": "USD",
"TotalFeeAmount": 9.69,
"CapturedAmount": 9.69,
"RefundedAmount": 9.69
},
"Succeeded": true,
"Error": null,
"CapturedValues": {}
}