Cancel an intent being processed

Cancels an intent created. The intent may have already been sent to the terminal for processing.

Used to cancel the current intent that the terminal is executing. Please note: during financial transactions, the transaction cannot be cancelled once the transaction has been sent to the card schemes for authorization.

Securityapi_key
Request
path Parameters
mid
required
string

Merchant Identifier.

intentId
required
string

Intent Identifier.

Request Body schema: application/json
tid
required
string

The device you wish to perform a cancel task.

Responses
204

Expected response body.

400

Bad request.

401

Invalid API key/MID.

403

Forbidden from performing this action.

404

The intent to reverse could not be found.

500
Callbacks
postCancel Callback(postback)
post/merchant/{mid}/intent/{intentId}/cancel
Request samples
application/json
{
  • "tid": "string"
}
Response samples
application/json

Thrown when trying to cancel an intent without providing a tid in the request body.

{
  • "statusCode": 400,
  • "error": "BadRequest",
  • "code": "NoTerminalIDProvided",
  • "message": "This intent is already processing - a Terminal ID is required to cancel."
}
Callback payload samples
POST: Cancel Callback(postback)
application/json
{
  • "intentId": "5657dc13-abcc-49ec-a305-ca23e0a5d0da",
  • "status": "CANCELLED",
  • "type": "PAYMENT"
}