Cancel authorization

Request

If you don’t want to proceed with a payment, you can send a cancel request Note: You can only cancel a payment which is authorized. If the payment is settled, you must create a refund.

Security

BasicAuth

Path

linkDatastringrequired

Action link that's received in your request

Content-Typestringrequired

Example:application/vnd.worldpay.payments-v6+json

Acceptstring

Example:application/vnd.worldpay.payments-v6.hal+json

curl -i -X POST \
  -u '<username>:<password>' \
  'https://try.access.worldpay-bsh.securedataplatform.co.uk/payments/authorizations/cancellations/{linkData}' \
  -H 'Accept: application/vnd.worldpay.payments-v6.hal+json' \
  -H 'Content-Type: application/vnd.worldpay.payments-v6+json'

Responses

The cancellation request has been accepted

Bodyapplication/vnd.worldpay.payments-v6.hal+json

Response

Request to cancel an authorization

{
  "_links": {
    "payments:events": {
      "href": "/payments/events/:linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}