Cancel an authorised payment (POST /payments/{paymentPspReference}/cancels)

Cancel an authorised payment

POST/payments/{paymentPspReference}/cancels

Use it in a workflow

Add a step and choose the Adyen connector.
Pick the Cancel an authorised payment (POST /payments/{paymentPspReference}/cancels) action (under Modifications).
Fill in the fields below, then reference the result from later steps as {{cancelAnAuthorisedPaymentPostPaymentsPaymentpspreferenceCancels.response.data}}.

Request

Path parameters

paymentPspReferencestringrequired

The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-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

Enter the body as JSON in the step's Body field.

applicationInfoobject

adyenLibraryobject2 fields

adyenPaymentSourceobject2 fields

externalPlatformobject3 fields

merchantApplicationobject2 fields

merchantDeviceobject3 fields

shopperInteractionDeviceobject3 fields

merchantAccountstringrequired

The merchant account that is used to process the payment.

referencestring

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

json

{
  "merchantAccount": "string",
  "applicationInfo": {
    "adyenLibrary": {
      "name": "string",
      "version": "string"
    },
    "adyenPaymentSource": {
      "name": "string",
      "version": "string"
    },
    "externalPlatform": {
      "integrator": "string",
      "name": "string",
      "version": "string"
    },
    "merchantApplication": {
      "name": "string",
      "version": "string"
    },
    "merchantDevice": {
      "os": "string",
      "osVersion": "string",
      "reference": "string"
    },
    "shopperInteractionDevice": {
      "locale": "string",
      "os": "string",
      "osVersion": "string"
    }
  },
  "reference": "string"
}

Response

Returns 201 with an object. Read it in later steps with {{cancelAnAuthorisedPaymentPostPaymentsPaymentpspreferenceCancels.response.data.<field>}}.

merchantAccountstring

The merchant account that is used to process the payment.

paymentPspReferencestring

The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to cancel.

pspReferencestring

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

referencestring

Your reference for the cancel request.

statusstring

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

One ofreceived

json

{
  "merchantAccount": "string",
  "paymentPspReference": "string",
  "pspReference": "string",
  "status": "received",
  "reference": "string"
}

Need more? See the Adyen guide for connection setup and behaviour shared by every action.

Was this page helpful?