v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Accounts

Fetch terminals assigned to the parent account

You can use this endpoint to fetch terminals linked to the parent account.

get/v1/accounts/terminals

Query parameters

limitinteger

This endpoint is paginated. limit describes the size of the page you are querying

cursorstring

The cursor is used to scroll to the next page. When making the first call to list all accounts, there is no need to pass in any cursor since the API has not returned any cursor back to you. Only use cursor when the API provides it

terminalIdstring

Terminal ID

serialNumberstring

Terminal ID

terminalLabelstring

Terminal Label

merchantNamestring

Merchant Name

Headers

accountIdstring uuid required

Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Response

OK - your request was successful.

codestring required

Response Code

descriptionstring required

Response description

Example response

{
  "code": "00",
  "description": "Success",
  "data": {
    "results": [
      {
        "terminalId": "201124LM",
        "serialNumber": "55555555",
        "accountId": "01a10aeb-d989-460a-bbde-9842f2b4320f",
        "merchantName": "trident and rees",
        "terminalLabel": "Testing",
        "createdAt": "2020-09-23T10:21:48.789Z",
        "updatedAt": "2023-09-04T15:23:55.173Z"
      }
    ],
    "cursor": "xchbaVFsjdsbaADddd"
  }
}