Terminals

List terminals

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.

get/v2/terminals

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/terminals
  • Auth: API key in header Authorization

Query parameters

terminalIdstring

Filter by terminal ID (ISO 8583 DE 41).

serialNostring

Filter by terminal serial number.

branchIdsstring

Comma-separated branch IDs to filter by.

labelstring

Comma-separated label IDs to filter by.

status'active' | 'inactive'

Filter by terminal status.

mode'test' | 'live'

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

merchantPayformanceIdstring

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

qstring

Quick search keyword.

sortBystring

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

sortType1 | -1

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

limitinteger

Number of records per page. Default: 20.

pageinteger

Page number. Default: 1.

Response

Your terminals.

Changes

No recorded changes to this operation across all 1 revision of this API.