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

You are viewing an old version of the API
Cancel terminal checkout

POST /v2/terminals/checkouts/{checkout_id}/cancel

Cancels a Terminal checkout request if the status of the request permits it.

Permissions
PAYMENTS_WRITE
Guide
Cancel a Terminal checkout Try in API Explorer

Path Parameters

Example code
Name Description
checkout_id
string
Required

The unique ID for the desired TerminalCheckout.

Request Body
Name Description

Response Fields
Name Description
errors
Error [ ]

Information about errors encountered during the request.
checkout
TerminalCheckout

The canceled TerminalCheckout.

Examples

You are viewing an old version of the API
POST /v2/terminals/checkouts/{checkout_id}/cancel
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js 
curl https://connect.squareup.com/v2/terminals/checkouts/S1yDlPQx7slqO/cancel \
  -X POST \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'
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"
  }
}