• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
Cancel payment by idempotency key

POST /v2/payments/cancel

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.


Permissions
PAYMENTS_WRITE
Try in API Explorer
Name Description
idempotency_key
string

Required

The idempotency_key identifying the payment to be canceled.

Min Length 1 Max Length 45

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
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/payments/cancel \
  -X POST \
  -H 'Square-Version: 2021-06-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "a7e36d40-d24b-11e8-b568-0800200c9a66"
  }'
Response JSON
{}

Share Feedback

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