For the complete documentation index, see llms.txt. This page is also available as Markdown.

List POS terminals

Returns a paginated list of POS terminals, ordered by identifier ascending unless the sort parameter says otherwise.

Only the identifier, the name and the code can be filtered on, and each of them matches the whole value. A parameter that is not one of those — gateway, for instance — is ignored and the unfiltered page is returned, so check the response count before assuming a filter was applied.

The response includes the config object of every terminal, credentials and all. Treat the response as sensitive.

get
/poses/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Query parameters
pageintegerOptional

The page number to return.

Default: 1
limitintegerOptional

The number of items to return per page.

Default: 10
sortstringOptional

Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.

Example: -id
idintegerOptional

Filter by the identifier of the terminal.

namestringOptional

Filter by name. The whole name must match, letter case included.

Example: Example POS
slugstringOptional

Filter by code. The whole code must match, letter case included; a partial code returns an empty page.

Example: example-pos
Responses
200

A page of POS terminals.

application/json

A paginated list of POS terminals.

countintegerOptional

Total number of POS terminals matching the request.

nextstring · nullableOptional

URL of the next page, or null if this is the last page.

previousstring · nullableOptional

URL of the previous page, or null if this is the first page.

get/poses/
GET /api/v1/remote/1/poses/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 1,
      "name": "Example POS",
      "slug": "example-pos",
      "gateway": "omnicore.libs.payment_gateways.garanti.GarantiGateway",
      "config": {
        "auth": {
          "merchant_id": "1234567",
          "terminal_id": "10000001",
          "username": "akinon",
          "password": "secret"
        },
        "three_d_enabled": true
      },
      "resource_url": "https://gateway.example.com/payment",
      "three_d_resource_url": "https://gateway.example.com/payment/3d"
    }
  ]
}

Last updated

Was this helpful?