You are viewing an old version of the 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 status of a CreatePayment request is unknown. For example, after you send a CreatePayment request a network error occurs and you don't 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 you want to cancel. After cancelling 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, the end point returns successfully.

Required permissions PAYMENTS_WRITE

Request Body

Name Description
idempotency_key
string

Required

idempotency_key identifying the payment to be canceled.

Max Length 45 Min Length 1

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

Examples

You are viewing an old version of the API
POST /v2/payments/cancel
cURL
  • cURL
  • Ruby
  • Python
curl https://connect.squareup.com/v2/payments/cancel \
  -X POST \
  -H 'Square-Version: 2019-11-20' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -d '{
    "idempotency_key": "a7e36d40-d24b-11e8-b568-0800200c9a66"
  }'
Response JSON
{}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?