Sign in
Modifications

Cancel an in-person refund

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.

post/voidPendingRefund

Request body

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.

merchantAccountstring required

The merchant account that is used to process the payment.

originalReferencestring

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

  • authorisation response
  • authorisation notification
referencestring

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

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

OK - the request has succeeded.

additionalDataobject

This field contains additional data, which may be returned in a particular modification response.

pspReferencestring required

Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.

response'[capture-received]' | '[cancel-received]' | '[refund-received]' | '[cancelOrRefund-received]' | '[adjustAuthorisation-received]' | '[donation-received]' | '[technical-cancel-received]' | '[voidPendingRefund-received]' | 'Authorised' | 'Refused' | 'Error' required

Indicates if the modification request has been received for processing.

Changes

Changed in 4 of the 51 revisions of this API.1633

  • v2520c98153769d2See the full diff
    • ●

      added the new Error enum value to the response response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new Refused enum value to the response response property for the response status 200

      response-property-enum-value-added

  • v2527588197cceb1See the full diff
    • ●

      added the new Authorised enum value to the response response property for the response status 200

      response-property-enum-value-added

  • v256522ce018f708See the full diff
    • ▲

      the request's body type/format changed from / to object/

      request-body-type-changed

    • ▲

      the modificationAmount request property type/format changed from / to object/

      request-property-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 400

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 401

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 403

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 422

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 500

      response-body-type-changed

  • v25da6633eb75e183See the full diff
    • ▲

      the request's body type/format changed from object/ to /

      request-body-type-changed

    • ▲

      the modificationAmount request property type/format changed from object/ to /

      request-property-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 400

      response-body-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 401

      response-body-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 403

      response-body-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 422

      response-body-type-changed

    • ▲

      the response's body type/format changed from object/ to / for status 500

      response-body-type-changed

    • ○

      removed the Authorised enum value from the response response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Error enum value from the response response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the Refused enum value from the response response property for the response status 200

      response-property-enum-value-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog