POST /orders/{reference}/refunds

Process a refund for an order ---- [auth scope: api-user]

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
orderReferencestringRequired

The unique order reference that was provided when creating the order. This is your merchant-specific identifier for the order. Use this reference to identify which order to perform operations on (e.g., capture, void, refund, get status).

Example: ORD-2024-001234
Body
refundReferencestringRequired

A unique reference identifier for this refund request. This must be unique per merchant.

Example: 12345001223
refundAmountall ofRequired

The currency and amount to be refunded to the customer. The currency must match the currency of the original order. The amount must be a positive number with up to 2 decimal places. For full refund, this should equal the order amount + surcharge amount. For partial refund (if the APM supports it), this can be any amount up to the remaining refundable amount (captured amount minus any previously refunded amounts). The sum of all refunds cannot exceed the total captured amount.

Example: {"amount":25,"currency":"AED"}
refundDescriptionstringRequired

A brief description or reason for the refund. This can be used to record why the refund was issued. This may be visible to the payment provider.

Example: Customer requested return due to defective product
Responses
200Success
application/json
post
/orders/{orderReference}/refund

Example Request/Response

{
    "refundReference": "TgEHcPtpN2HSrTMK-0",
    "refundAmount": {
        "amount": 100,
        "currency": "AUD"
    },
    "refundDescription": "Please refund this order"
}
PreviousPOST /captureNextWidgets Overview

Last updated