<- Payments API

Payments API

Cancel payment by idempotency key



Cancels (voids) a payment identified by the idempotency key that is specified in the request.

Use this method when the status of a CreatePayment request is unknown (for example, after you send a CreatePayment request, a network error occurs and you do not get a response). In this case, you can direct Square to cancel the payment using this endpoint. In the request, you provide the same idempotency key that you provided in your CreatePayment request that you want to cancel. After canceling the payment, you can submit your CreatePayment request again.

Note that if no payment with the specified idempotency key is found, no action is taken and the endpoint returns successfully.

Try in API Explorer
Link to section

Request body

Example code

Link to section




The idempotency_key identifying the payment to be canceled.

Link to section

Response fields

Link to section


Any errors that occurred during the request.