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.
Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.
The page number to return.
1The number of items to return per page.
10Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.
-idFilter by the identifier of the terminal.
Filter by name. The whole name must match, letter case included.
Example POSFilter by code. The whole code must match, letter case included; a partial code returns an empty page.
example-posA page of POS terminals.
A paginated list of POS terminals.
Total number of POS terminals matching the request.
URL of the next page, or null if this is the last page.
URL of the previous page, or null if this is the first page.
Authentication credentials were not provided or are invalid.
The authenticated user does not have administrator privileges.
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?

