> For the complete documentation index, see [llms.txt](https://apidocs.akinon.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.akinon.com/commerce-openapis/admin/pos-terminals/list-pos-terminals.md).

# 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.

```json
{"openapi":"3.1.0","info":{"title":"Admin API","version":"1.0.0"},"tags":[{"name":"POS Terminals","description":"Administrative endpoints for **POS terminals** — the virtual POS records that connect the store to a payment gateway. Each record holds the gateway a payment is sent through, the service addresses of that gateway, and the credentials and gateway-specific options it needs.\n\nA POS terminal is never chosen by the customer. Every card registered on the platform points at the terminals to use for its cash, installment, 3D secure and installment-with-3D payments, and the multi-currency records of a card point at further terminals per currency. At payment time the platform takes the terminal selected for the card, builds the gateway from the record, and sends the request to the stored service address.\n\n## Core Capabilities\n\n**1. Listing & Filtering**\n* Retrieve a paginated list of POS terminals, ordered by identifier ascending.\n* Filter by identifier, name or code. All three filters match the whole value exactly; partial values return an empty page.\n* Order results with the `sort` parameter, as described under **Sorting**.\n\n**2. Full CRUD**\n* Register a terminal with its gateway, service addresses and configuration.\n* Fully or partially update an existing terminal.\n* Delete a terminal. `DELETE` **permanently removes** the record — there is no soft delete, and a terminal cannot be deactivated through this API. See **Deleting a Terminal** for what a deletion takes with it and when it is refused.\n\n**3. Uniqueness**\n* The `slug` code identifies a terminal and must be unique across all terminals. A create or update that would repeat an existing code is rejected with `<code> already exists`.\n\n## Read and Write Representations\n\nThe `gateway` field is asymmetric. On create and update, send either the short gateway code (for example `garanti`) or the full gateway value listed beside it in the table below; both are accepted, and both are case-sensitive. On read the field is always returned as the full gateway value, never as the short code — so a client that writes `garanti` reads back `omnicore.libs.payment_gateways.garanti.GarantiGateway`.\n\n## Supported Gateways\n\n| Code | Value returned on read |\n|------|------------------------|\n| `garanti` | `omnicore.libs.payment_gateways.garanti.GarantiGateway` |\n| `nestpay` | `omnicore.libs.payment_gateways.nestpay.NestpayGateway` |\n| `cmi` | `omnicore.libs.payment_gateways.cmi.CMIGateway` |\n| `posnet` | `omnicore.libs.payment_gateways.posnet.PosnetGateway` |\n| `payu` | `omnicore.libs.payment_gateways.payu.PayUGateway` |\n| `mastercard` | `omnicore.libs.payment_gateways.mastercard.MastercardGateway` |\n| `masterpass` | `omnicore.libs.payment_gateways.masterpass.MasterpassGateway` |\n| `bex` | `omnicore.libs.payment_gateways.bex.BexGateway` |\n| `hyperpay` | `omnicore.libs.payment_gateways.hyper_pay.HyperpayGateway` |\n| `payu_poland` | `omnicore.libs.payment_gateways.paymentsos.PayUPolandGateway` |\n| `payu_romania` | `omnicore.libs.payment_gateways.paymentsos.PayURomaniaGateway` |\n| `payu_ro` | `omnicore.libs.payment_gateways.payu_ro.PayuRoGateway` |\n| `fastpay` | `omnicore.libs.payment_gateways.fastpay.FastPayGateway` |\n| `maximumpay` | `omnicore.libs.payment_gateways.maximumpay.MaximumPayGateway` |\n| `liqpay` | `omnicore.libs.payment_gateways.liqpay.LiqPayGateway` |\n| `gpay` | `omnicore.libs.payment_gateways.gpay.GPayGateway` |\n| `easypay` | `omnicore.libs.payment_gateways.easypay.EasyPayGateway` |\n| `mobilexpress` | `omnicore.libs.payment_gateways.mobilexpress.MobilExpressGateway` |\n| `mobilexpress_credit_card` | `omnicore.libs.payment_gateways.mobilexpress.MobilExpressCreditCardGateway` |\n| `iyzico` | `omnicore.libs.payment_gateways.iyzico.IyzicoGateway` |\n| `iyzico_bkm` | `omnicore.libs.payment_gateways.iyzico.IyzicoBKMGateway` |\n| `finansbank` | `omnicore.libs.payment_gateways.finansbank.FinansBankGateway` |\n| `denizbank` | `omnicore.libs.payment_gateways.denizbank.DenizBankGateway` |\n| `yandex_money` | `omnicore.libs.payment_gateways.yandex_money.YandexMoneyGateway` |\n| `paypal` | `omnicore.libs.payment_gateways.paypal.PaypalGateway` |\n| `alpha` | `omnicore.libs.payment_gateways.alpha.AlphaGateway` |\n| `dummypay` | `omnicore.libs.payment_gateways.dummypay.DummyPayGateway` |\n| `ykb_credit` | `omnicore.libs.payment_gateways.ykb_credit.YKBCreditGateway` |\n| `compay` | `omnicore.libs.payment_gateways.compay.ComPayGateway` |\n| `compay_credit` | `omnicore.libs.payment_gateways.compay.ComPayCreditGateway` |\n| `param` | `omnicore.libs.payment_gateways.param.ParamGateway` |\n| `garanti_switch` | `omnicore.libs.payment_gateways.garanti_switch.GarantiSwitchGateway` |\n| `pay_with_iyzico` | `omnicore.libs.payment_gateways.iyzico.PayWithIyzicoGateway` |\n| `tompay` | `omnicore.libs.payment_gateways.tompay.TomPayGateway` |\n| `iyzico_funds_transfer` | `omnicore.libs.payment_gateways.iyzico.IyzicoFundsTransferGateway` |\n| `paycell` | `omnicore.libs.payment_gateways.paycell.PaycellGateway` |\n| `posas_giftcard` | `omnicore.libs.payment_gateways.posas_giftcard.PosAsGiftCardGateway` |\n| `multisafepay` | `omnicore.libs.payment_gateways.multisafepay.MultiSafepayGateway` |\n| `garanti_credit` | `omnicore.libs.payment_gateways.garanti_credit.GarantiCreditGateway` |\n| `multisafepay_direct` | `omnicore.libs.payment_gateways.multisafepay.MultiSafepayDirectGateway` |\n| `ozan` | `omnicore.libs.payment_gateways.ozan.OzanGateway` |\n| `netopia` | `omnicore.libs.payment_gateways.netopia.NetopiaGateway` |\n| `teqpay` | `omnicore.libs.payment_gateways.teqpay.TeqPayGateway` |\n| `payu_pl` | `omnicore.libs.payment_gateways.payu_pl.PayuPLGateway` |\n| `stripe` | `omnicore.libs.payment_gateways.stripe.StripeGateway` |\n| `bulut` | `omnicore.libs.payment_gateways.bulut.BulutGateway` |\n| `fiba_credit` | `omnicore.libs.payment_gateways.fibabank.FibaCreditGateway` |\n| `mobilexpress_hosted` | `omnicore.libs.payment_gateways.mobilexpress_hosted.MobilExpressHostedGateway` |\n| `paymob` | `omnicore.libs.payment_gateways.paymob.PaymobGateway` |\n| `tompay_credit` | `omnicore.libs.payment_gateways.tompay_credit.TompayCreditGateway` |\n| `paytr` | `omnicore.libs.payment_gateways.paytr.PaytrGateway` |\n| `payzee` | `omnicore.libs.payment_gateways.payzee.PayzeeGateway` |\n| `mobilexpress_v8_cc` | `omnicore.libs.payment_gateways.mobilexpress_v8.MobilExpressV8CreditCardGateway` |\n| `ykb_worldpay` | `omnicore.libs.payment_gateways.ykb_worldpay.YKBWorldPayGateway` |\n| `extension` | `omnicore.libs.payment_gateways.payment_extension.PaymentExtensionClient` |\n| `vakifbank` | `omnicore.libs.payment_gateways.vakifbank.VakifBankGateway` |\n| `bulut_direct` | `omnicore.libs.payment_gateways.bulut.BulutDirectGateway` |\n| `eren_card` | `omnicore.libs.payment_gateways.eren_card.ErenCardGateway` |\n| `craftgate` | `omnicore.libs.payment_gateways.craftgate.CraftgateGateway` |\n| `iyzico_saved_card` | `omnicore.libs.payment_gateways.iyzico.IyzicoSavedCardGateway` |\n| `checkout` | `omnicore.libs.payment_gateways.checkout.CheckoutGateway` |\n| `checkout_apple_pay` | `omnicore.libs.payment_gateways.checkout.CheckoutApplePayGateway` |\n| `zip_credit` | `omnicore.libs.payment_gateways.zip_credit.ZipCreditGateway` |\n| `mobilexpress_wire_transfer` | `omnicore.libs.payment_gateways.mobilexpress_v8.MobilExpressWireTransferGateway` |\n| `payu_ro_paybyclick` | `omnicore.libs.payment_gateways.payu_ro.PayuRoByClickGateway` |\n| `payu_ro_saved_card` | `omnicore.libs.payment_gateways.payu_ro.PayURoSavedCardGateway` |\n| `paybyme` | `omnicore.libs.payment_gateways.paybyme.PaybymeGateway` |\n| `sipay` | `omnicore.libs.payment_gateways.sipay.SipayGateway` |\n| `paywall` | `omnicore.libs.payment_gateways.paywall.PaywallGateway` |\n| `dummy_psp` | `omnicore.libs.payment_gateways.dummypay.DummyPSP` |\n| `tap` | `omnicore.libs.payment_gateways.tap.TapGateway` |\n| `qpay_tap` | `omnicore.libs.payment_gateways.tap.QpayTapGateway` |\n| `tap_saved_card` | `omnicore.libs.payment_gateways.tap.TapSavedCardGateway` |\n| `akbank` | `omnicore.libs.payment_gateways.akbank.AkbankGateway` |\n| `hepsipay` | `omnicore.libs.payment_gateways.hepsipay.HepsipayGateway` |\n| `qnb_pay` | `omnicore.libs.payment_gateways.qnb_pay.QNBPayGateway` |\n| `cybersource` | `omnicore.libs.payment_gateways.cybersource.CybersourceGateway` |\n| `cybersource_applepay` | `omnicore.libs.payment_gateways.cybersource.CybersourceApplepayGateway` |\n| `moka` | `omnicore.libs.payment_gateways.moka.MokaCreditCardGateway` |\n| `masterpass_rest` | `omnicore.libs.payment_gateways.masterpass.MasterpassRESTGateway` |\n| `benefit_tap` | `omnicore.libs.payment_gateways.tap.BenefitTapGateway` |\n| `craftgate_masterpass` | `omnicore.libs.payment_gateways.craftgate.CraftgateMasterpassGateway` |\n| `checkout_flow` | `omnicore.libs.payment_gateways.checkout.CheckoutFlowGateway` |\n| `nkolay` | `omnicore.libs.payment_gateways.nkolay.NKolayGateway` |\n| `mastercard_applepay` | `omnicore.libs.payment_gateways.mastercard.MastercardApplePayGateway` |\n| `tap_applepay` | `omnicore.libs.payment_gateways.tap.ApplePayTapGateway` |\n| `tap_googlepay` | `omnicore.libs.payment_gateways.tap.GooglePayViaTapGateway` |\n| `cybersource_uc` | `omnicore.libs.payment_gateways.cybersource.CybersourceUCGateway` |\n| `payten` | `omnicore.libs.payment_gateways.payten.PaytenGateway` |\n| `payu_blik` | `omnicore.libs.payment_gateways.payu_europe.PayUBLIKGateway` |\n| `payu_visa_mobile` | `omnicore.libs.payment_gateways.payu_europe.PayUVisaMobileGateway` |\n| `payu_googlepay` | `omnicore.libs.payment_gateways.payu_europe.PayUGooglePayGateway` |\n| `payu_applepay` | `omnicore.libs.payment_gateways.payu_europe.PayUApplePayGateway` |\n| `payu_creditcard` | `omnicore.libs.payment_gateways.payu_europe.PayUCreditCardGateway` |\n| `ngenius` | `omnicore.libs.payment_gateways.ngenius.NGeniusGateway` |\n## Gateway Configuration\n\nThe `config` object carries everything the selected gateway needs beyond its service addresses. It is stored exactly as sent: its contents are not validated against the selected gateway, so a terminal with an incomplete or misspelled configuration is accepted here but cannot process payments. The object is also returned in full on read, credentials included, so treat responses from these endpoints as sensitive.\n\nThree keys are read by the platform itself for every gateway:\n\n| Key | Type | Effect |\n|-----|------|--------|\n| `auth` | object | The credentials of the gateway. Which keys belong in it is defined by the gateway; a terminal without it cannot send a payment request. |\n| `three_d_enabled` | boolean | When `true`, payments made through this terminal are redirected to 3D secure verification, subject to the 3D secure settings described under **Dynamic Settings & Environment Variables**. Absent or `false` means no redirection is requested by the terminal itself. |\n| `installment_filter_enabled` | boolean | When `true`, the installment options offered for this terminal are narrowed by the configured installment filters (see `INSTALLMENT_FILTERS` under **Dynamic Settings & Environment Variables**). |\n\nEvery other key is handed to the gateway unchanged, so the integration documentation of the gateway you are configuring is authoritative for the rest of the object — including keys such as a store key, a bank code or a saved-card terminal identifier that only some gateways read.\n\n## Field Constraints\n\n| Field | Constraints |\n|-------|-------------|\n| `name` | Required; at most 64 characters. |\n| `slug` | Required; may not be empty; at most 64 characters. The value is not checked against the code format, so spaces and punctuation are accepted — send a plain lower-case code with hyphens. |\n| `gateway` | Required; must be one of the values in **Supported Gateways**. |\n| `resource_url` | Required; must be a valid URL of at most 200 characters. |\n| `three_d_resource_url` | Optional; may be `null`; must be a valid URL of at most 200 characters. |\n| `config` | Optional, but may not be `null`. Send an object. |\n\nFields that are not part of the terminal are ignored rather than rejected, and the identifier in a request body is ignored as well — it is assigned by the server.\n\n## Deleting a Terminal\n\n> **Warning:** Deletion is permanent, and it is not limited to the terminal record. The payment transaction records that were sent through the terminal are removed together with it, and that history cannot be recovered.\n\nA deletion is refused while the terminal is still referenced elsewhere — by a card, by a multi-currency record of a card, by a stored card of a customer, or as the main terminal of a past transaction. Point those records at another terminal first, or keep the terminal in place.\n\n## Sorting\n\nThe `sort` parameter accepts `pk`, `name`, `slug`, `gateway`, `resource_url`, `three_d_resource_url` and `config`. Prefix a field with a hyphen for descending order. Any other value — including the creation and modification timestamps, which are not part of the terminal representation — is ignored and the default ordering by identifier is kept.\n\nTwo of these deserve a note. Sorting by `gateway` orders terminals by the full gateway value rather than by the short code, so the order follows the value returned on read. Sorting by `config` is accepted but orders records by the raw content of the object, which rarely produces a useful order.\n\n## Dynamic Settings & Environment Variables\n\nNo dynamic setting changes the behaviour of the administrative endpoints described here: every action stays available and behaves identically regardless of how the settings are configured. The settings below determine how the terminals managed here are **used when a payment is taken**, and each is referenced again where it relates to a field of the terminal.\n\n| Key | Type | Default | Effect |\n|-----|------|---------|--------|\n| `THREE_D_SECURE_ENABLED` | boolean | the server configuration value of the same name, and `false` if that is unset | The master switch for 3D secure verification. While it is off, no payment is redirected to verification even when `three_d_enabled` is set in a terminal's configuration, and the `three_d_resource_url` stored here is never used. |\n| `THREE_D_SECURE_RULES` | array of objects, each holding a rule and its parameters | the server configuration value of the same name, and empty if that is unset | The rules that decide, per payment, whether a terminal that requests 3D secure actually redirects. While the list is empty, the `three_d_enabled` flag of the terminal alone decides. One of the available rules matches terminals by their `slug` code, so the codes assigned here are the values that rule is configured with. |\n| `INSTALLMENT_FILTERS` | array of objects, each holding a filter and its parameters | the server configuration value of the same name, and empty if that is unset | The filters that narrow the installment options of a terminal whose configuration sets `installment_filter_enabled`. While the list is empty, that flag has no visible effect. |\n\n**Environment variables:** No environment variables are read by these endpoints. The related server configuration values are `THREE_D_SECURE_ENABLED`, `THREE_D_SECURE_RULES` and `INSTALLMENT_FILTERS`, which seed the defaults of the dynamic settings above, and `THREE_D_VALIDATE_CARD_TYPE` (off by default) and `THREE_D_REDIRECT_DEBIT` (on by default), which further affect whether a payment is redirected to 3D secure verification at payment time."}],"servers":[{"description":"Omnitron Remote Proxy (external access — recommended)","url":"https://{omnitron_url}/api/v1/remote/{channel_id}","variables":{"omnitron_url":{"default":"sandbox.akinon.com","description":"Omnitron server URL (e.g., {omnitron.akinon.com})"},"channel_id":{"default":"1","description":"The channel identifier the remote request is routed through"}}},{"description":"Commerce API Server (internal / direct access only)","url":"https://{commerce_url}/api/v1","variables":{"commerce_url":{"default":"sandbox.akinon.com","description":"Internal commerce server URL, reachable only from within the Omnitron network"}}}],"security":[{"tokenAuth":[]}],"components":{"securitySchemes":{"tokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Token credential sent in the Authorization header, in the form: `Token <your-token>`. Requires a staff (admin) account."}},"parameters":{"page":{"name":"page","in":"query","required":false,"description":"The page number to return.","schema":{"type":"integer","default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"The number of items to return per page.","schema":{"type":"integer","default":10}},"sort":{"name":"sort","in":"query","required":false,"description":"Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (`-`) for descending order.","schema":{"type":"string"}}},"schemas":{"PaginatedPosList":{"type":"object","description":"A paginated list of POS terminals.","properties":{"count":{"type":"integer","description":"Total number of POS terminals matching the request."},"next":{"type":["string","null"],"format":"uri","description":"URL of the next page, or `null` if this is the last page."},"previous":{"type":["string","null"],"format":"uri","description":"URL of the previous page, or `null` if this is the first page."},"results":{"type":"array","description":"The POS terminals on the current page.","items":{"$ref":"#/components/schemas/Pos"}}}},"Pos":{"type":"object","description":"A POS terminal returned by the API. The response carries the full gateway configuration, credentials included, so treat it as sensitive.","properties":{"pk":{"type":"integer","readOnly":true,"description":"Unique identifier of the POS terminal."},"name":{"type":"string","maxLength":64,"description":"Display name of the terminal."},"slug":{"type":"string","description":"The code that identifies the terminal. Unique across all terminals."},"gateway":{"type":"string","description":"The gateway payments are sent through, returned as the full gateway value. See **Supported Gateways** for the short code that corresponds to each value."},"config":{"type":"object","description":"Everything the gateway needs beyond its service addresses, returned exactly as it was stored. See **Gateway Configuration** for the keys the platform itself reads.","additionalProperties":true},"resource_url":{"type":"string","format":"uri","maxLength":200,"description":"The gateway address payment requests are sent to."},"three_d_resource_url":{"type":["string","null"],"format":"uri","maxLength":200,"description":"The gateway address used when a payment is redirected to 3D secure verification. `null` when the terminal has none."}},"required":["pk","name","slug","gateway","config","resource_url","three_d_resource_url"]},"Error":{"type":"object","description":"An error response.","properties":{"detail":{"type":"string","description":"A human-readable description of the error."}},"additionalProperties":true}},"responses":{"Unauthorized":{"description":"Authentication credentials were not provided or are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Forbidden":{"description":"The authenticated user does not have administrator privileges.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/poses/":{"get":{"tags":["POS Terminals"],"operationId":"listPoses","summary":"List POS terminals","description":"Returns a paginated list of POS terminals, ordered by identifier ascending unless the `sort` parameter says otherwise.\n\nOnly 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.\n\nThe response includes the `config` object of every terminal, credentials and all. Treat the response as sensitive.","parameters":[{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/sort"},{"name":"id","in":"query","description":"Filter by the identifier of the terminal.","required":false,"schema":{"type":"integer"}},{"name":"name","in":"query","description":"Filter by name. The whole name must match, letter case included.","required":false,"schema":{"type":"string"}},{"name":"slug","in":"query","description":"Filter by code. The whole code must match, letter case included; a partial code returns an empty page.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A page of POS terminals.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedPosList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://apidocs.akinon.com/commerce-openapis/admin/pos-terminals/list-pos-terminals.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
