POS API
Full reference for the miaPOS POS API. Endpoints, schemas, examples, error codes.
Overview
The POS API drives multi-OEM hardware terminals (Sunmi, SmartOne, Datecs, Ingenico, PAX) and SoftPOS apps.
Endpoints
POST/pos/api/v1/activate
POST/pos/api/v1/payment/start
GET/pos/api/v1/payment/{paymentId}
POST/pos/api/v1/payment/{paymentId}/cancel
GET/pos/api/v1/settlement/{terminalId}
Schemas
Request and response schemas for each endpoint follow the same envelope conventions described in Signatures and Errors. Field-level definitions are documented per endpoint above.
Errors
All endpoints return errors in the standard envelope. See Errors for the full catalog.