Cancel terminal checkout BETA
Cancels a Terminal checkout request, if the status of the request permits it.
Required permissions:
PAYMENTS_WRITE
Path Parameters
| Name | Description |
|---|---|
checkout_id
Required
|
Unique ID for the desired |
Response Fields
| Name | Description |
|---|---|
errors
|
Information on errors encountered during the request. |
checkout
|
The updated |
Examples
You are viewing an old version of the API
POST
/v2/terminals/checkouts/{checkout_id}/cancel
cURL
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/terminals/checkouts/S1yDlPQx7slqO/cancel \
-X POST \
-H 'Square-Version: 2020-06-25' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Response JSON
{
"checkout": {
"id": "S1yDlPQx7slqO",
"amount_money": {
"amount": 123,
"currency": "USD"
},
"reference_id": "id36815",
"device_options": {
"device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
"tip_settings": {
"allow_tipping": true
},
"skip_receipt_screen": true
},
"status": "CANCELED",
"cancel_reason": "SELLER_CANCELED",
"created_at": "2020-03-16T15:31:19.934Z",
"updated_at": "2020-03-16T15:31:45.787Z",
"app_id": "APP_ID",
"deadline_duration": "PT10M"
}
}