Dismiss terminal actionBeta

POST

/v2/terminals/actions/{action_id}/dismiss

Dismisses a Terminal action request if the status and type of the request permits it.

See Link and Dismiss Actions for more details.

Permissions:PAYMENTS_WRITE

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

action_id

string

Required

Unique ID for the TerminalAction associated with the action to be dismissed.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

action

Current state of the action to be dismissed.

Link to section

Examples

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

curl https://connect.squareup.com/v2/terminals/actions/termapia%3Aabcdefg1234567/dismiss \
  -X POST \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "action": {
    "id": "termapia:abcdefg1234567",
    "device_id": "DEVICE_ID",
    "deadline_duration": "PT5M",
    "created_at": "2021-07-28T23:22:07.476Z",
    "updated_at": "2021-07-28T23:22:29.511Z",
    "await_next_action": true,
    "await_next_action_duration": "PT5M",
    "status": "COMPLETED",
    "type": "CONFIRMATION",
    "app_id": "APP_ID",
    "confirmation_options": {
      "title": "Marketing communications",
      "body": "I agree to receive promotional emails about future events and activities.",
      "agree_button_text": "Agree",
      "disagree_button_text": "Decline",
      "decision": {
        "has_agreed": true
      }
    }
  }
}