Skip to navigation

Cancel a card read

Sends a cancel request to the terminal and marks the interaction as cancelled. Only interactions in the pending state can be cancelled.

Only read-card interactions can be cancelled. charge-card interactions don’t support cancellation.

A successful cancel returns 200 OK with no response body.

Authentication

AuthorizationBearer

Use a Payments API key as the bearer token: Authorization: Bearer <api_key>. Get a fresh key from Refresh API Keys.

Path parameters

device_idstringRequired

Hardware Serial Number (HSN) of the terminal, provided by your Integration Delivery lead.

interaction_idstringRequiredformat: "uuid"

The interaction_id returned when the interaction was created.

Query parameters

midstringOptional

Merchant ID. Required when your bearer token is an ISV token acting on behalf of a merchant. If the mid can't be resolved to an authorized account, the request returns 400.

Response

Interaction cancelled. No response body.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error