Skip to content

Submit a payment cancel request

Request

Send a 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.

Security
BasicAuth
Path
linkDatastringrequired
Headers
WP-Api-Versionstringrequired

The API version

Value:"2024-06-01"
Example:2024-06-01
Bodyapplication/json
referencestring, [ 1 .. 128 ] characters^[-A-Za-z0-9]*$

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

Example:"full-cancellation-reference"
{ "reference": "full-cancellation-reference" }

Responses

Accepted

Bodyapplication/json
outcomestring
Value:"sentForCancellation"
Response
{ "outcome": "sentForCancellation", "_links": { "self": { "href": "https://try.access.worldpay.com/api/payments/eyJrIjoxLCJkIjoiN3VTNVpzK1h4UVFNL1R4aGZjSVV5TFFhMWZlNXRLOVM3M0k1MVdwN21PMXIySnNadTJ5YUhzZE45dDN5TDRnYk8rQk9PTzJzVWUxTkZUeXFBWjJZMUE9PSJ9" } } }