Refund or cancel a payment

post/payments/{paymentPspReference}/reversals

Refunds a payment if it has already been captured, and cancels a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCEL_OR_REFUND webhook.

The reversed amount is always the full payment amount.

Do not use this request for payments that involve multiple partial captures.

For more information, refer to Reversal.

Endpoint destination URL
https://checkout-test.adyen.com/v68/payments/{paymentPspReference}/reversals
Click to copy

Header Parameters

Idempotency-Keystring

A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).

Path Parameters

paymentPspReferencestringRequired

The pspReference of the payment that you want to reverse.

Request Parameters

applicationInfoobject

Information about your application. For more details, see Building Adyen solutions.

merchantAccountstringRequired

The merchant account that is used to process the payment.

referencestring

Your reference for the reversal request. Maximum length: 80 characters.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 201 - Created

    The request has been fulfilled and has resulted in one or more new resources being created.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less