Docs · API reference

External Integration API

Full reference for the miaPOS External Integration API. Endpoints, schemas, examples, error codes.

AudienceDeveloper
DifficultyIntermediate
Updated2026-05-30

Overview

The External Integration API is for ISVs and platforms that provision merchants on behalf of their users — multi-tenant onboarding, programmatic terminal creation, settlement export.

Endpoints

POST/integration/api/v1/merchant
POST/integration/api/v1/terminal
GET/integration/api/v1/merchant/{merchantId}/settlement
POST/integration/api/v1/webhook

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.