Endpoint Index
Base URL: https://api-gateway.lunixi.com/api/v1/physical-pos
| Method | Path | Scope | Page |
|---|---|---|---|
POST | /payments | physical_pos:payments | Sale |
POST | /payments/{paymentId}/reversals | physical_pos:payments | Reversal Rules |
POST | /payments/{paymentId}/cancel | physical_pos:payments | Cancel Before Start |
GET | /payments/{paymentId} | physical_pos:view or physical_pos:payments | Retrieve a Payment |
GET | /payments | physical_pos:view or physical_pos:payments | List Payments |
GET | /transactions | physical_pos:view or physical_pos:payments | Transactions |
GET | /transactions/ambiguous | physical_pos:view or physical_pos:payments | Transactions |
GET | /transactions/{paymentId} | physical_pos:view or physical_pos:payments | Transactions |
GET | /reports/sales-summary | physical_pos:view or physical_pos:payments | Reports |
GET | /reports/tax-summary | physical_pos:view or physical_pos:payments | Reports |
GET | /settlements | physical_pos:view or physical_pos:payments | End-of-Day Records |
POST | /devices/{deviceId}/settlement | physical_pos:payments | Start End of Day |
GET | /settlement-runs | physical_pos:view or physical_pos:payments | Start End of Day |
GET | /settlement-runs/{runId} | physical_pos:view or physical_pos:payments | Start End of Day |
GET | /settlement-policy, /stores/{storeId}/settlement-policy, /devices/{deviceId}/settlement-policy | physical_pos:view | End-of-Day Policy |
PUT, DELETE | /settlement-policy, /stores/{storeId}/settlement-policy, /devices/{deviceId}/settlement-policy | physical_pos:manage | End-of-Day Policy |
GET | /devices/{deviceId}/settlement-policy/effective | physical_pos:view | End-of-Day Policy |
GET | /catalog/vendors | physical_pos:view | Catalog |
GET | /catalog/device-models | physical_pos:view | Catalog |
GET | /catalog/acquirers | physical_pos:view | Catalog |
GET | /stores | physical_pos:view | Stores |
POST | /stores | physical_pos:manage | Stores |
GET | /stores/{storeId} | physical_pos:view | Stores |
PATCH | /stores/{storeId} | physical_pos:manage | Stores |
POST | /stores/{storeId}/archive | physical_pos:manage | Stores |
POST | /stores/{storeId}/restore | physical_pos:manage | Stores |
GET | /stores/{storeId}/audit | physical_pos:view | Stores |
GET | /stores/{storeId}/registers | physical_pos:view | Registers |
POST | /stores/{storeId}/registers | physical_pos:manage | Registers |
PATCH | /registers/{registerId} | physical_pos:manage | Registers |
POST | /registers/{registerId}/archive | physical_pos:manage | Registers |
POST | /registers/{registerId}/restore | physical_pos:manage | Registers |
GET | /registers/{registerId}/audit | physical_pos:view | Registers |
GET | /terminals | physical_pos:view | Logical Terminals |
POST | /terminals | physical_pos:manage | Logical Terminals |
GET | /terminals/{terminalId} | physical_pos:view | Logical Terminals |
PATCH | /terminals/{terminalId} | physical_pos:manage | Logical Terminals |
POST | /terminals/{terminalId}/close | physical_pos:manage | Logical Terminals |
GET | /terminals/{terminalId}/audit | physical_pos:view | Logical Terminals |
GET | /terminals/{terminalId}/acquirers | physical_pos:view | Bank Rows |
POST | /terminals/{terminalId}/acquirers | physical_pos:manage | Bank Rows |
PATCH | /terminal-acquirers/{terminalAcquirerId} | physical_pos:manage | Bank Rows |
GET | /terminals/{terminalId}/providers | physical_pos:view | Card Provider Rows |
POST | /terminals/{terminalId}/providers | physical_pos:manage | Card Provider Rows |
PATCH | /terminal-providers/{terminalProviderId} | physical_pos:manage | Card Provider Rows |
GET | /devices | physical_pos:view | Devices |
POST | /devices | physical_pos:manage | Devices |
GET | /devices/{deviceId} | physical_pos:view | Devices |
PATCH | /devices/{deviceId} | physical_pos:manage | Devices |
POST | /devices/{deviceId}/assignment | physical_pos:manage | Devices |
POST | /devices/{deviceId}/assignment/close | physical_pos:manage | Devices |
POST | /devices/{deviceId}/lifecycle | physical_pos:manage | Devices |
POST | /devices/{deviceId}/retire | physical_pos:manage | Devices |
GET | /devices/{deviceId}/assignments | physical_pos:view | Devices |
GET | /devices/{deviceId}/audit | physical_pos:view | Devices |
POST | /terminals/{terminalId}/device-link | physical_pos:manage | Device Link |
POST | /terminals/{terminalId}/device-link/close | physical_pos:manage | Device Link |
GET | /terminals/{terminalId}/links | physical_pos:view | Device Link |
POST | /devices/{deviceId}/activation-code | physical_pos:identity | Device Identity |
POST | /devices/{deviceId}/activation-code/revoke | physical_pos:identity | Device Identity |
GET | /devices/{deviceId}/keys | physical_pos:view | Device Identity |
POST | /devices/{deviceId}/keys/{keyId}/revoke | physical_pos:identity | Device Identity |
POST | /devices/{deviceId}/keys/{keyId}/revert-enrollment | physical_pos:identity | Device Identity |
GET | /overview | physical_pos:view | Overview Counts |
These endpoints require a request signed with your API key, and the key must carry the Physical POS product (PHYSICAL_POS). → Authentication and Scopes