Cancel an in-person refund

post/voidPendingRefund

This endpoint allows you to cancel an unreferenced refund request before it has been completed.

In your call, you can refer to the original refund request either by using the tenderReference, or the pspReference. We recommend implementing based on the tenderReference, as this is generated for both offline and online transactions.

For more information, refer to Cancel an unreferenced refund.

Endpoint destination URL
https://pal-test.adyen.com/pal/servlet/Payment/v68/voidPendingRefund
Click to copy

Request Parameters

additionalDataobject

This field contains additional data, which may be required for a particular modification request.

The additionalData object consists of entries, each of which includes the key and value.

merchantAccountstringRequired

The merchant account that is used to process the payment.

modificationAmountobject

The amount that needs to be captured/refunded. Required for /capture and /refund, not allowed for /cancel. The currency must match the currency used in authorisation, the value must be smaller than or equal to the authorised amount.

mpiDataobject

Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).

originalMerchantReferencestring

The original merchant reference to cancel.

originalReferencestring

The original pspReference of the payment to modify. This reference is returned in:

  • authorisation response
  • authorisation notification
platformChargebackLogicobject

Defines how to book chargebacks when using Adyen for Platforms.

referencestring

Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters.

splitsarray[object]

An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to Providing split information.

tenderReferencestring

The transaction reference provided by the PED. For point-of-sale integrations only.

uniqueTerminalIdstring

Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only.

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

  • 200 - OK

    The request has succeeded.

    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