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

You are viewing an old version of the API
Get terminal action BETA

GET /v2/terminals/actions/{action_id}

Retrieves a Terminal action request by action_id.

Terminal action requests are available for 30 days.


Permissions
PAYMENTS_READ
Try in API Explorer
Name Description
action_id
string

Required

Unique ID for the desired TerminalAction

Response Fields

Name Description
errors
Error [ ]

Information on errors encountered during the request.

action
TerminalAction

The requested TerminalAction

Examples

You are viewing an old version of the API
GET /v2/terminals/actions/{action_id}
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/terminals/actions/termapia%3AjveJIAkkAjILHkdCE \
  -H 'Square-Version: 2022-11-16' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "action": {
    "id": "termapia:jveJIAkkAjILHkdCE",
    "device_id": "DEVICE_ID",
    "deadline_duration": "PT5M",
    "status": "IN_PROGRESS",
    "created_at": "2021-07-28T23:22:07.476Z",
    "updated_at": "2021-07-28T23:22:08.301Z",
    "location_id": "LOCATION_ID",
    "type": "SAVE_CARD",
    "app_id": "APP_ID",
    "save_card_options": {
      "customer_id": "CUSTOMER_ID",
      "reference_id": "user-id-1"
    }
  }
}