Sign in
Modifications

Cancel an authorised payment

Cancels the authorisation on a payment that has not yet been captured, and returns a unique reference for this request. You get the outcome of the request asynchronously, in a CANCELLATION webhook.

If you want to cancel a payment but don't have the pspReference, use the /cancels endpoint instead.

If you want to cancel a payment but are not sure whether it has been captured, use the /payments/{paymentPspReference}/reversals endpoint instead.

For more information, refer to Cancel.

post/payments/{paymentPspReference}/cancels

Path parameters

paymentPspReferencestring required

The pspReference of the payment that you want to cancel.

Headers

Idempotency-Keystring

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

Request body

merchantAccountstring required

The merchant account that is used to process the payment.

referencestring

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

Response

Created - the request has been fulfilled and has resulted in one or more new resources being created.

merchantAccountstring required

The merchant account that is used to process the payment.

paymentPspReferencestring required

The pspReference of the payment to cancel.

pspReferencestring required

Adyen's 16-character reference associated with the cancel request.

referencestring

Your reference for the cancel request.

status'received' required

The status of your request. This will always have the value received.

Changes

Changed in 3 of the 54 revisions of this API.5

  • v70e74b6569ea743See the full diff
    • ○

      added the new optional request property enhancedSchemeData/carRental

      new-optional-request-property

    • ○

      added the new optional request property enhancedSchemeData/lodging

      new-optional-request-property

    • ○

      added the new optional request property enhancedSchemeData/temporaryServices

      new-optional-request-property

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

  • v70d5c50d69824f1See the full diff
    • ○

      added the new optional request property enhancedSchemeData/levelTwoThree

      new-optional-request-property

  • v7037689fc71cc91See the full diff
    • ○

      added the new optional request property enhancedSchemeData

      new-optional-request-property