Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
account-terminals

aid_account_management_terminals_post

Register a physical payment terminal and associate it with a store.

scopes:

  • admin:accounts
  • write:accounts
post/accounts/{aid}/terminals

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

Request body

device_serial_numberstring required

Hardware serial number printed on the device.

store_idstring required

The client-supplied store_id of the store to associate this terminal with.

Example request

{
  "device_serial_number": "123456789012",
  "store_id": "S312"
}

Response

Terminal

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
device_modelstring
store_idstring
terminal_idstring required
device_serial_numberstring required
status'DELETED' | 'PENDING' | 'ACTION_REQUIRED' | 'ACTIVE' | 'INACTIVE' | 'ERROR'

The status of the terminal

status_reason'CHECK_UPDATE'

Context explaining why the terminal has its current status.

Example response

{
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "terminal_id": "T12233302-T0001",
  "device_serial_number": "123456789012"
}