Refund payment - Freedom Pay

Refunds a debited payment fully or partially.
The X-Action header must be gateway.payment.refund.
Refund is possible only for a payment in status success; to cancel a hold that is not cleared use gateway.payment.reverse.
Several partial refunds are allowed while their total with reversals does not exceed the payment amount.
The refund creates a child refund payment and is processed asynchronously; get the final status via gateway.payment.status or gateway.request.status.
A rejected refund is returned with HTTP 200 as a failed refund payment with status error; it is also listed in refund_payments of the original payment.

Refund flow

Several partial refunds are allowed: repeat the call while the total of successful refunds and reversals does not exceed the payment amount.
The status of the payment stays success; count only refund_payments items with status success.

Responses

🟢200OK

application/json

Headers

Bodyapplication/json

Examples

Partial refund acceptedFull refund acceptedRepeated request (same X-Request-Id)Rejected: amount exceeds the available amountRejected: invalid payment statusRejected: refund disabled for the merchantResult not ready (X-Request-Status: process)

{
  "id": "01a133d6-91e2-7993-8302-61572319a64a",
  "amount": 100,
  "refund_payment": {
    "id": "01a133d6-9e79-7b54-969c-4b269bd9b2e3",
    "status": "process",
    "amount": -30
  }
}

🟠400Bad Request

🟠422Unprocessable Entity

🟠401Unauthorized

🔴500Internal Server Error