ApiOrder Administration
Record refund
Records a refund against an order. The order must be in Confirmed or Fulfilled status. If the refund equals the order total, the order status changes to Refunded.
Authorization
Bearer AuthorizationBearer <token>
Enter your bearer token from the Pylon Auth API.
In: header
Path Parameters
id*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/problem+json
curl -X POST "https://loading/api/v1/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08/refund" \ -H "Content-Type: application/json" \ -d '{ "amount": 0.1, "refundReference": "string", "reason": "string" }'{
"success": true,
"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"newRefundedAmount": 0.1,
"isFullyRefunded": true
}{
"code": "string",
"message": "string"
}{
"code": "string",
"message": "string"
}