refund

POST 
/refund

The merchant sends a request to this endpoint to refund an order partially or in full. This can only be done when the order has been confirmed ('order_confirmed').

Request

application/json

Body

required

backd_order_id stringrequired
merchant_order_id stringrequired
refund_amount numberrequired

Responses

200

Refund details.

application/json

Schema

Schema

order_total numberrequired
cart_amount numberrequired
tax_amount numberrequired
shipping_amount numberrequired
discount_amount numberrequired
status stringrequired
merchant_order_id stringrequired
refunds object[]
Array [
amount numberrequired
create_date stringrequired
status stringrequired
]
items object[]
Array [
item_id stringrequired
name stringrequired
quantity integerrequired
price numberrequired
]

Example (from schema)

{
  "order_total": 150,
  "cart_amount": 120,
  "tax_amount": 20,
  "shipping_amount": 10,
  "discount_amount": 0,
  "status": "order_refunded",
  "merchant_order_id": "12345ABC",
  "refunds": [
    {
      "amount": 50,
      "create_date": "2024-12-01T12:00:00Z",
      "status": "completed"
    }
  ],
  "items": [
    {
      "item_id": "item001",
      "name": "Product Name",
      "quantity": 2,
      "price": 50
    }
  ]
}

Loading...