Shipment Refund
Contains details about a shipment's refund status and amounts.
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| Status | ShipmentRefundStatus | Yes | Current status of the refund request. |
| TrackingNumber | string | Yes | Tracking number associated with the shipment. |
| Barcode | string | No | Scannable barcode of the shipment label. |
| CurrencyCode | string | Yes | Currency code (ISO 4217) for the amounts. |
| TotalFeeAmount | decimal | Yes | Original total fee amount for the shipment. |
| CapturedAmount | decimal | No | Amount that was captured/charged from the customer. |
| RefundedAmount | decimal | No | Amount that has been refunded to the customer. |
ShipmentRefundStatus enums
| Property | Description |
|---|---|
| Requested | The refund request is pending. |
| Accepted | The refund request is accepted, and the refund is being processed. |
| Refunded | The refund is completed, you should have the money back in your account. |
| Rejected | The refund request is rejected. |
You may be charged for processing refund request.