No momento, esta página não está disponível em português
Checkout icon

Reversal

Return the funds to the shopper when you are not sure whether the payment has been captured.

If you are not sure if a payment has been captured, you can use a reversal to return the funds to the shopper.

A reversal does one of the following:

  • If the payment has not been captured, it cancels the payment.
  • If the payment has been captured, it refunds the payment.

Requirements

Requirement Description
Integration type An online payments integration.
Customer Area roles To edit capture settings, make sure that you have the following roles:
  • Merchant admin
  • View Payments
  • Merchant manage payments
Webhooks Listen for webhook messages with the following eventCode value:
Limitations You cannot use a reversal for the following cases: In these cases, check if the payment has been captured, and cancel or refund it.

Reverse a payment

Make a POST  /payments/{paymentPspReference}/reversals request, including the following:

Parameter Required Description
paymentPspReference
Path parameter		 -white_check_mark- The PSP reference of the payment. You can find this in the following:
  • The webhook message with eventCode: AUTHORISATION for the payment.
  • In your Customer Area, in the list of payments (Transactions > Payments).
  • If you made a /payments request for the payment, the /payments response.
merchantAccount -white_check_mark- Your merchant account used to process the payment.
reference Your reference for the reversal request. For reconciliation, this can be useful to identify a partial cancel or refund.

The /payments/{paymentPspReference}/reversals  response includes a pspReference, Adyen's unique reference associated with this reversal request.

{
    "merchantAccount": "ADYEN_MERCHANT_ACCOUNT",
    "paymentPspReference": "VK9DRSLLRCQ2WN82",
    "pspReference" : "TF995R5G6L2GWR82",
    "reference": "YOUR_UNIQUE_REFERENCE",
    "status" : "received"
}

CANCEL_OR_REFUND webhook

You receive the outcome of the reversal request asynchronously, in a webhook message that includes the following:

Parameter Description
eventCode CANCEL_OR_REFUND
originalReference The PSP reference of the original payment.
pspReference The PSP reference of the reversal that you can find in the /payments/{paymentPspReference}/reversals response
success Indicates the outcome of the refund validations. Possible values:
  • true: Adyen's validations were successful and we sent the refund request to the card scheme. This usually means that the refund will be processed successfully. However, in rare cases the refund can be rejected by the card scheme, or reversed. For information about these exceptions, see REFUND_FAILED webhook, and REFUNDED_REVERSED webhook.
  • false: the refund validations failed. The webhook includes a reason field with a short description of the problem. Review the reason, fix the issue if possible, and resubmit the refund request.

For more information about the included fields, see the CANCEL_OR_REFUND webhook reference.

See also