Skip to main content

Create Refund

Initiates a refund request for the specified shipment.

Endpoint: POST /api/shipments/{id}/refund

Required Scope: shipments:write

Path Parameter​

ParameterTypeRequiredDescription
idstringYesThe ID of the shipment to refund.

Response Specification​

Returns a Shipment Refund object wrapped in Result.

Sample JSON​

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