Cancel partial authorization

Request

If you don't want to proceed with a payment, you can send a partial 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-v7+json

Acceptstringrequired

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

Bodyapplication/vnd.worldpay.payments-v7+json

referencestring, [ 1 .. 128 ] characters^[-A-Za-z0-9]*$required

A reference generated by you to identify a payment throughout its lifecycle.

Example:"partial-cancellation-reference"

valueobjectrequired

An object that contains information about the value of the payment.

Request to partially cancel the authorization

{
  "value": {
    "amount": 500,
    "currency": "EUR"
  },
  "reference": "partial-cancel-reference"
}

Responses

The partial cancellation request has been accepted

Bodyapplication/vnd.worldpay.payments-v7+json

_linksobject

Response

Response to cancel an authorization

{
  "_links": {
    "cardPayments:events": {
      "href": "/payments/events/:linkData"
    },
    "cardPayments:partialCancel": {
      "href": "/payments/authorizations/cancellations/partials/:linkData"
    },
    "cardPayments:partialSettle": {
      "href": "/payments/settlements/partials/:linkData"
    },
    "curies": [
      {
        "name": "payments",
        "href": "/rels/payments/{rel}",
        "templated": true
      }
    ]
  }
}