Cancel payment (reverse)

Cancels the hold of a two-step payment (auto_clearing = false) and releases the funds.
The X-Action header must be gateway.payment.reverse.
Reversal is possible only for a payment in status approved that is not cleared; for a cleared payment use gateway.payment.refund.
The reversal creates a child reversal payment and is processed asynchronously; get the final status via gateway.payment.status (the payment gets status reversed) or gateway.request.status.
A rejected reversal is returned with HTTP 200 as a failed reversal payment with status error; it is also listed in reverse_payments of the original payment.
The full two-step flow (create, clearing or reverse, refund) is shown in Capture payment (clearing).

Responses

🟢200OK

application/json

Headers

Bodyapplication/json

Examples

Reversal acceptedRepeated request (same X-Request-Id)Rejected: invalid payment statusRejected: reversal disabled for the merchantResult not ready (X-Request-Status: process)

{
  "id": "01a133ca-fa79-7f0c-82d7-7c04ba783963",
  "amount": 100,
  "reverse_payment": {
    "id": "01a133cb-07bc-7115-8c30-afe77ae49495",
    "status": "process"
  }
}

🟠400Bad Request

🟠422Unprocessable Entity

🟠401Unauthorized

🔴500Internal Server Error