Terminals

List of endpoints to interact with terminal(s) from the POS integration prospective.

Get Terminal status by ID.

Retrieve status of the terminal. If terminal had been subscribed for push notifications, system will send push notification to terminal to get an actual status. System will wait for the response for 45 seconds.

SecurityBearer or Bearer or Bearer or Bearer

Request

path Parameters

id

required

string <uuid>

TerminalId

Responses

200

Success

get/pos-api/v1/terminals/{id}/status

Request samples

curl

Response samples

200

application/json

{"terminalId": "00000000-0000-0000-0000-000000000000",
"terminalPosStatusId": 1,
"terminalPosStatus": "Active"
}

List merchant terminals.

SecurityBearer or Bearer or Bearer or Bearer

Request

query Parameters

page	integer <int32>
pageSize	integer <int32>
asc	boolean
orderBy	string
search	string
deliveryStatusId	integer <int32>
serialNumber	string
manufacturer	string
manufacturerId	integer <int32>
model	string

Responses

200

Success

get/pos-api/v1/terminals

Request samples

curl

Response samples

200

application/json

{"items": [{"id": "9c63eba7-2943-4d48-9d73-713656c45581",
"merchantId": "8f32303b-6337-4f1a-a6a9-742b6906af50",
"serialNumber": "SN00000001",
"terminalManufacturer": "SUNMI",
"terminalModel": "Pro 1",
"deliveryStatusId": 3,
"deliveryStatusName": "Active",
"createdOn": "2024-10-30T23:44:26.0289767Z",
"modifiedOn": "2024-10-30T23:44:26.0289771Z",
"merchantCompanyName": "Merchant",
"terminalModeId": 1,
"terminalModeName": null
}
],
"total": 3
}

➔ Next to Ping