Skip to content

Partner API

All endpoints use POST with prefix {baseUrl}/open-api/v1. Include auth headers on every request — see Authentication.

Common response

json
{
  "code": "000000",
  "message": "success",
  "data": { }
}
FieldDescription
code000000 = success; see Error Codes
messageHuman-readable message
dataPayload (may be empty)

Endpoint index

CategoryEndpointDescription
SystemPOST Health CheckVerify credentials & signature
PackagesPOST List PackagesPaginated package catalog
OrdersPOST Create OrderDebit wallet & create order
OrdersPOST Query OrderQuery by orderNo / transactionId
OrdersPOST Refund OrderFull or partial refund
ProfilesPOST List ProfilesPaginated profile list
ProfilesPOST Cancel / RevokeCancel unused profile
ProfilesPOST Suspend / UnsuspendNot all packages support
ProfilesPOST Usage QueryData usage
AccountPOST Balance QueryBALANCE wallet
AccountPOST Top Up ApplyOffline transfer voucher
WebhookPOST Set Callback URLConfigure webhook URL
WebhookPOST Query Callback URLGet current URL
RegionsPOST List RegionsSupported countries

Full JSON Schema: OpenAPI Spec.

eSIM Dealer Open API v1