Cancel terminal actionBeta

POST

/v2/terminals/actions/{action_id}/cancel

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

Permissions:PAYMENTS_WRITE

Guide

Cancel a Terminal Action

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

action_id

string

Required

Unique ID for the desired TerminalAction.

Link to section

Request body

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

action

The canceled TerminalAction

Link to section

Examples

POST /v2/terminals/actions/{action_id}/cancel

curl https://connect.squareup.com/v2/terminals/actions/termapia%3AjveJIAkkAjILHkdCE/cancel \
  -X POST \
  -H 'Square-Version: 2023-08-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response JSON

{
  "action": {
    "id": "termapia:jveJIAkkAjILHkdCE",
    "device_id": "DEVICE_ID",
    "deadline_duration": "PT5M",
    "created_at": "2021-07-28T23:22:07.476Z",
    "updated_at": "2021-07-28T23:22:29.511Z",
    "status": "CANCELED",
    "cancel_reason": "SELLER_CANCELED",
    "location_id": "LOCATION_ID",
    "type": "SAVE_CARD",
    "app_id": "APP_ID",
    "save_card_options": {
      "customer_id": "CUSTOMER_ID",
      "reference_id": "user-id-1"
    }
  }
}

Cancel terminal actionBeta

Path parameters

Request body

Response fields

Error descriptions