v1

latestOpenAPI 3.0.32026-07-2418074.2 KB
Refunds

Simplified Refund

This API is to be used to process refunds for captured orders.

post/payments/simplified-refund/{order_id}

Request body

commentstring required

Notes or comments as a reference point that will be added to this order's transaction history.

merchant_refund_idstring

Used to input the merchant's own internal refund ID, if any, to be stored on the refund request and order details.

Example request

{
  "total_amount": {
    "amount": 300,
    "currency": "SAR"
  },
  "comment": "Refund for the order A123",
  "merchant_refund_id": "RefundID1"
}

Response

Refund Successful

order_idstring uuid
commentstring
refund_idstring uuid
capture_idstring uuid
status'fully_refunded' | 'partially_refunded'