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

Link to section

Path parameters

Example code

Link to section

checkout_id

string

Required

The unique ID for the desired TerminalCheckout.

Link to section

Request body

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

checkout

The canceled TerminalCheckout.

Link to section

Examples

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

curl https://connect.squareup.com/v2/terminals/checkouts/S1yDlPQx7slqO/cancel \
  -X POST \
  -H 'Square-Version: 2024-11-20' \
  -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
    },
    "location_id": "LOCATION_ID",
    "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": "PT5M"
  }
}