Submit a payment partial cancel request

Request

Send a partial cancel request if you don't want to proceed with a payment.

Note: You can only cancel a payment which is authorized. If the payment is settled, you must create a refund.

Important

You can only do a partial cancellation once for a payment.

If you send a second partial cancellation request, we will not reject it. Instead, we will fully cancel the remaining authorized amount, regardless of the value.amount you pass in that second request.

Security

BasicAuth

Path

linkDatastringrequired

WP-Api-Versionstringrequired

The API version

Value:"2024-06-01"

Example:2024-06-01

Bodyapplication/jsonrequired

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

valueobjectrequired

The value and currency.

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

Responses

Accepted

Bodyapplication/json

outcomestring

Value:"sentForCancellation"

_linksobject

Return details about the status of the payment.

Response

{
  "outcome": "sentForCancellation",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/api/payments/eyJrIjoiazNhYjYzMiIsImxpbmtWZXJzaW9uIjoiNS4wLjAifQ%3D%3D.sN%3Ag8wd64bwkbrp0md%2BbPxcanBnk2zLdsIqSa1pR99GeDrCwEtsymFb5gQw9WlrStDTK3eIWPy93y%3A7njc4649JSrU7%2BvFDl1J36%2BcwOkX0lW4Z%2BfnZKMutoUGX3m1%3Am1abCnrwHIBOLZ%3A8ZpsSaLoyDtB%3A8H%2BxSOOOGjEbko3O%3A%3A7gTMASwaw7KY3SuOCoh4KCq84ktTU7AB2kOFpTY0bs7pWRQKSZJKSFIJvAisP8cBzFPzqireuqfCu5ojcm60gRSsqS3glurO24RJkg5SrpRjgY6g7ca8uoA7tKDk9OVOIwORF5sGPHSSGMa2bEl2lMUkAANoWclQHiGzxWQQ3ZOMOj3ix5oo3ctSHv2uo5m6InByzI1XuTONS3N8O%2B1%2BuC8Xk67Ze0uAJk%2BrJN9o7Z%3AVhRHFzbbwymcuTiRbNw%3D"
    }
  }
}