Create terminal actionBeta

POST

/v2/terminals/actions

Creates a Terminal action request and sends it to the specified device.

Permissions:PAYMENTS_WRITE

Guide

Request a Square Terminal Action

Try in API Explorer

Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A unique string that identifies this CreateAction request. Keys can be any valid string but must be unique for every CreateAction request.

See Idempotency keys for more information.

Min Length

Max Length

Link to section

action

Required

The Action to create.

Show attributes

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Show attributes

Link to section

action

The created TerminalAction

Show attributes

Link to section

Examples

POST /v2/terminals/actions

curl https://connect.squareup.com/v2/terminals/actions \
  -X POST \
  -H 'Square-Version: 2023-03-15' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "idempotency_key": "thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e",
    "action": {
      "device_id": "{{DEVICE_ID}}",
      "type": "SAVE_CARD",
      "deadline_duration": "PT5M",
      "save_card_options": {
        "customer_id": "{{CUSTOMER_ID}}",
        "reference_id": "user-id-1"
      }
    }
  }'

Response JSON

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

Create terminal actionBeta

Request body

Response fields

Error descriptions