CancelOrRefundModificationRequest

To initiate a cancellation or refund of an authorised payment that may or may not have been captured, send a modification request to the /cancelOrRefund endpoint.

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

Pass the following parameters:

Name

Type

Required

Description

merchantAccount

String (tick)

The merchant account where the transaction, for which the request needs to be initiated, was processed

tenderReference

String (tick) The transaction reference provided by the PED.

uniqueTerminalId

String (tick)

Unique terminal ID for the PED that originally processed the request.

reference String (error)

If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports.

Max length: 80 characters.

additionalData.cancelOrRefundReason String (error) The reason why the cancel or refund is being performed.

Alternatively, you can implement based on the pspReference, after it has been generated by the Adyen payments platform:

Name

Type

Required

Description

merchantAccount

String (tick)

The merchant account where the transaction, for which the request needs to be initiated, was processed

originalReference

String (tick)

The  originalReference value corresponds to the  pspReference value assigned to the original payment.

You receive the pspReference with:

  • The payment status, or
  • The authorisation notification.

reference String (error)

If you want, you can specify your reference for the modification request. This reference will be visible in the Customer Area and in reports.

Max length: 80 characters.