Skip to main content

Terminal — Cancel Event

Cancels any ongoing event on the RM Terminal (e.g., an active Quick Pay or Card Payment that has not yet completed).

When to Use

Use this endpoint when:

  • Customer abandons a payment mid-flow
  • You need to abort an unresponsive terminal event before retry

How to Use

Endpoint
POST/v3/payment/terminal/quickpay

Step 1: Authenticate

Obtain a valid accessToken.

Step 2: Send the Event

POST with type: "CANCEL" and the terminal ID.

Step 3: Verify Cancellation

A "SUCCESS" code confirms the cancel event was sent.


Request Parameters

terminalIdSTRINGrequired

RM Terminal ID

typeSTRINGrequired

Event type. Set to "CANCEL".

Response Parameters

codeSTRING

"SUCCESS" if the cancel event was sent to terminal, otherwise an error code.

errorOBJECT

Error details

codeSTRING

Error code if the request failed.

messageSTRING

Error message if the request failed.

debugSTRING

Debug message (sandbox only).