DEVELOPER PLATFORM · REST API

Build with a clearer API.

Read your account, explore the current catalogue, and reconcile billing with one scoped integration. Start with a key, then test each live endpoint.

Explore API docs ↗Create an API key →

✓ REST + JSON✓ Scoped keys✓ Server-side access

API at a glanceLIVE ROUTES

GET

/account

Read account profile and balance.

GET

/countries

List enabled countries with optional filters.

GET

/services

List enabled services and platforms.

GET

/offers

Browse current offers, prices and stock status.

$ curl /api/v1/third-party/account
{ "data": { "balance": "…" } }

ⓘ Live today: account, catalogue and billing reads. Number ordering, SMS retrieval and webhooks are not yet available to third-party clients.

01 / BUILD WITH CONFIDENCE

Designed for integrations that need clarity.

A small, predictable API surface lets you ship the essentials without guessing which capabilities are ready.

◫

Current catalogue

Countries, services and offers from enabled listings.

◇

Least-privilege keys

Grant account, catalogue or billing scope as needed.

↗

Test what is live

Pair the reference with a manual request tester.

02 / QUICKSTART

From key to first response in minutes.

Create a scoped key in your dashboard, call the account endpoint, then use catalogue and billing reads as your workflow grows.

Create a scoped key

Name your integration and grant only the access it needs.

Make your first call

Request the account endpoint from your backend.

Explore live resources

Read catalogue and billing data with the same integration.

Your first request

curl 'http://localhost/api/v1/third-party/account' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: YOUR_API_KEY'

Browse countries

curl 'http://localhost/api/v1/third-party/countries?product_type=activation' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: YOUR_API_KEY'

Reconcile top-ups

curl 'http://localhost/api/v1/third-party/topups?per_page=15' \
  -H 'Accept: application/json' \
  -H 'X-API-Key: YOUR_API_KEY'

03 / SECURITY

Keep access scoped and server-side.

Pass a scoped key as X-API-Key or a Bearer token over HTTPS. Never expose it in browser code or a public repository.

⌁

Your key, your scopes

Create up to five active keys. Grant only the access needed; revoke keys in your dashboard.

Manage API keys →

♢

Server-side by default

Keep keys in a secret manager. Browser code can expose them, even when the UI masks them.

Supported headers

X-API-Key: YOUR_API_KEY
# or
Authorization: Bearer YOUR_API_KEY

04 / REST API V1

A focused REST surface.

Use JSON responses for the resources already available. Each route lists its required key scope.

Base URL http://localhost/api/v1/third-party

Endpoint	Scope	What it returns
GET`/account`	account.read	Read account profile and balance.
GET`/countries`	catalog.read	List enabled countries with optional filters.
GET`/services`	catalog.read	List enabled services and platforms.
GET`/offers`	catalog.read	Browse current offers, prices and stock status.
GET`/topups`	billing.read	Read paginated top-up history.
GET`/transactions`	billing.read	Read paginated balance entries.

Open interactive API reference →

05 / PRODUCT DISCOVERY

Explore the live catalogue.

Browse countries, services and offers before building product discovery. Listings do not guarantee provider stock or acceptance.

GET /countries

countries

List enabled countries with optional filters.

GET /services

services

List enabled services and platforms.

GET /offers

offers

Browse current offers, prices and stock status.

06 / ACCOUNT & BILLING

Reconcile payments and balance movement.

Read paginated top-ups and transactions with a billing-scoped key.

GET /topups

topups

Read paginated top-up history.

GET /transactions

transactions

Read paginated balance entries.

Billing endpoints are read-only. Confirm top-up status before treating a payment as credited.

07 / RELIABILITY

Predictable errors and safe retries.

Handle validation, authentication and rate-limit responses explicitly. Do not blindly retry financial operations.

401 / 403

Access

Check the key, its active state and required scope.

422

Validation

Review query parameters before retrying.

429

Rate limits

Back off rather than using tight polling loops.

08 / CHOOSE YOUR WORKFLOW

Choose the right integration route.

Use the third-party API for your server-to-server account, catalogue and billing reads. Use the customer dashboard for manual work.

Task	Third-party API	Customer dashboard
Read account balance	Available	Available
Browse current catalogue	Available	Available
Review billing history	Available	Available
Order a number or retrieve SMS	Not yet available	Product workflow only

09 / ANSWERS

Frequently asked questions

Account, countries, services, offers, top-ups and transactions are live as read-only REST endpoints.

10 / ENDPOINT REFERENCE

Full reference, with a live tester.

Review current paths, scopes and request examples. Send manual calls in the API docs workspace.

Ready to build on what is live?

Create a scoped key and test a real response before connecting your backend.

API docs & tester ↗Create key →