Cancel payment
POST
/v2/payments/{payment_id}/cancel
Cancels (voids) a payment.
You can use this endpoint to cancel a payment with
the APPROVED status.
| Name | Description |
|---|---|
payment_
Required
|
The ID of the payment to cancel. |
Response Fields
| Name | Description |
|---|---|
errors
|
Information about errors encountered during the request. |
payment
|
The successfully canceled |
Examples
POST
/v2/payments/{payment_id}/cancel
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
- Node.js
curl https://connect.squareup.com/v2/payments/GQTFp1ZlXdpoW4o6eGiZhbjosiDFf/cancel \
-X POST \
-H 'Square-Version: 2021-05-13' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Response JSON
{
"payment": {
"id": "GQTFp1ZlXdpoW4o6eGiZhbjosiDFf",
"created_at": "2018-10-17T20:38:46.743Z",
"updated_at": "2018-10-17T20:38:57.693Z",
"amount_money": {
"amount": 200,
"currency": "USD"
},
"app_fee_money": {
"amount": 10,
"currency": "USD"
},
"total_money": {
"amount": 200,
"currency": "USD"
},
"approved_money": {
"amount": 200,
"currency": "USD"
},
"status": "CANCELED",
"source_type": "CARD",
"card_details": {
"status": "VOIDED",
"card": {
"card_brand": "VISA",
"last_4": "1234",
"exp_month": 2,
"exp_year": 2024,
"fingerprint": "sq-1-9PP0tWfcM6vIsYmfsesdjfhduHSDFNdJFNDfDNFjdfjpseirDErsaP",
"card_type": "DEBIT",
"prepaid_type": "PREPAID",
"bin": "411111"
},
"entry_method": "KEYED",
"cvv_status": "CVV_ACCEPTED",
"avs_status": "AVS_ACCEPTED",
"auth_result_code": "eWZBDh",
"statement_description": "SQ *MY MERCHANT",
"card_payment_timeline": {
"authorized_at": "2018-10-17T20:38:46.753Z",
"voided_at": "2018-10-17T20:38:57.793Z"
}
},
"location_id": "XTI0H92143A39",
"order_id": "m2Hr8Hk8A3CTyQQ1k4ynExg92tO3",
"reference_id": "123456",
"note": "Brief description",
"customer_id": "RDX9Z4XTIZR7MRZJUXNY9HUK6I",
"version_token": "lAITJ6l8I8tFu62mCf2W4sxJQxN9FOaH5zwfsdPf7Dm6o"
}
}