Skip to main content
POST
Cancels a payment. You can only cancel while no funds are involved (e.g. status WAITING) — otherwise the call answers 400 {"error":"Payment cannot be cancelled"}. The action is audit-logged. This endpoint takes no request body — the payment is identified by the paymentId path parameter, so an empty playground body is expected.
Check the payment’s status before cancelling: once any funds are involved, cancel answers 400. For a payment that has already settled, use a refund instead.

Authorization

  • API-key scope: payments:cancel · JWT team permission: payments:manage
  • Your merchant account must be active.
string
required
24-hex payment id from create/list.

Response fields

boolean
true when the payment was cancelled; its status flips to CANCELLED — also visible on the public GET /getInvoiceStatus. Cancelling the same payment again answers 400.

Errors

See also