E-comm API
Full reference for the miaPOS E-comm API. Endpoints, schemas, examples, error codes.
Overview
The E-comm API powers website checkouts, payment links, and most plugin integrations. The authoritative protocol description lives in the public integration repo: Protocol Overview. Try the full flow against the sandbox at the interactive demo.
Endpoints
POST/ecomm/api/v1/token
POST/ecomm/api/v1/token/refresh
POST/ecomm/api/v1/pay
GET/ecomm/api/v1/payment/{paymentId}
POST/ecomm/api/v1/payment/{paymentId}/refund
GET/ecomm/api/v1/public-key
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.