KashierDevelopersKashier Developers

List terminals

curl -X GET "https://test-api.kashier.io/v2/terminals"
{  "terminals": [    {      "_id": "string",      "terminalId": "string",      "serialNo": "string",      "brandModel": "string",      "merchantPayformanceId": "string",      "branchName": "string",      "address": "string",      "status": "active",      "mode": "test",      "communicationMethod": "data",      "limits": {},      "createdAt": "string"    }  ],  "pagination": {    "total": 0,    "limit": 0,    "page": 0,    "pages": 0  }}

Retrieves the POS terminals registered on your merchant account. The list can be filtered by terminal ID, serial number, branch, label, status, and mode, and is paginated and sortable.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Query Parameters

terminalId?string

Filter by terminal ID (ISO 8583 DE 41).

serialNo?string

Filter by terminal serial number.

branchIds?string

Comma-separated branch IDs to filter by.

label?string

Comma-separated label IDs to filter by.

status?string

Filter by terminal status.

Value in

  • "active"
  • "inactive"
mode?string

Filter by terminal mode. A test terminal never touches the live card networks.

Value in

  • "test"
  • "live"
merchantPayformanceId?string

Filter by merchant ID, e.g. YOUR_MID. Useful when your account has connected accounts.

q?string

Quick search keyword.

sortBy?string

Field name to sort by, e.g. createdAt.

sortType?integer

Sorting direction: 1 = ascending, -1 = descending.

Value in

  • 1
  • -1
limit?integer

Number of records per page. Default: 20.

page?integer

Page number. Default: 1.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/terminals