ADadyen
Modifications

Cancel an authorisation

Changed on

Cancels the authorisation hold on a payment, returning a unique reference for this request. You can cancel payments after authorisation only for payment methods that support distinct authorisations and captures.

For more information, refer to Cancel.

This endpoint is inactive and is no longer supported for new integrations.

The Checkout API enables your online payments integration to accept all supported payment methods, use the latest features, and access more benefits.

post/cancel

Request

  • Base URL
    https://pal-test.adyen.com/pal/servlet/Payment/v51
  • URL
    https://pal-test.adyen.com/pal/servlet/Payment/v51/cancel
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

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.

originalMerchantReferencestring

The original merchant reference to cancel.

originalReferencestring required

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

  • v51384b6a469631Revision changes
    • warning

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

    • warning

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

  • v51bd2d73cfb99aRevision changes
    • info

      added the new TopUp enum value to the request property //