POST/ecr/{serialNumber}/payment/{paymentId}/void

Void a payment on an ECR terminal

Triggers a void for a payment on an ECR terminal. Supply the terminal's serialNumber and the target paymentId to identify the payment to reverse. The response includes the payment result and reversal status.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters
serialNumberstringrequired
The serial number of the ECR terminal associated with the payment.
paymentIdstringrequired
The unique identifier of the payment to void.

2 status codes
200Returns the void result, including payment details and the reversal status.
dataobjectoptional
messagestringoptional
Contains error message
statusstringrequired
400Returned when the void request is invalid; the response can include an error message and details about the invalid parameter.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional

Error handling

A 400 is returned when the void request is invalid. The serialNumber path parameter must identify the ECR terminal, and the paymentId path parameter must identify the payment to void.