Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendit eSIM API

eSIM plans and activation

Zendit eSIM API is one of 8 APIs that Zendit publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include eSIM. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, a JSON-LD context, and 2 JSON Schemas.

This API exposes 9 operations across 7 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.zendit.io/v1.

9 operations 7 paths 9 schemas 7 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.zendit.io/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Zendit eSIM API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (BearerAuth).

  • BearerAuth — Bearer token authentication using your Zendit API key.

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 7 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

eSIM 9

eSIM plans and activation

GET
/esim/offers
Zendit List ESIM Offers
listEsimOffers 4 params → 200
GET
/esim/offers/{offerId}
Zendit Get ESIM Offer
getEsimOffer 1 param → 200
GET
/esim/purchases
Zendit List ESIM Purchases
listEsimPurchases 3 params → 200
POST
/esim/purchases
Zendit Create ESIM Purchase
createEsimPurchase body → 201
GET
/esim/purchases/{transactionId}
Zendit Get ESIM Purchase
getEsimPurchase 1 param → 200
GET
/esim/purchases/{transactionId}/qrcode
Zendit Get ESIM QR Code
getEsimQrCode 1 param → 200
GET
/esim/{iccId}/plans
Zendit Get ESIM Plans
getEsimPlans 1 param → 200
GET
/esim/purchases/{transactionId}/refund
Zendit Get ESIM Refund
getEsimRefund 1 param → 200
POST
/esim/purchases/{transactionId}/refund
Zendit Create ESIM Refund
createEsimRefund 1 param → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Offer (9 properties), Purchase (8 properties), EsimPlan (5 properties), Refund (5 properties). Each schema is shown below with its type and property counts.

EsimPurchaseRequest
object
eSIM purchase request.
3 properties 1 required
Offer
object
Product offer (top-up, eSIM, voucher).
9 properties
Purchase
object
Purchase transaction.
8 properties
Refund
object
Refund status for an eSIM purchase.
5 properties
PurchaseList
object
Paginated purchase list.
4 properties
Price
object
Monetary amount with currency.
2 properties
EsimPlanList
object
List of eSIM plans for an ICC ID.
2 properties
EsimPlan
object
Active or queued eSIM plan.
5 properties
OfferList
object
Paginated offer list.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendit-esim-api-openapi.yml Raw ↑

Other APIs Zendit publishes across the network.

Zendit Account API
Zendit Brands API
Zendit Mobile Top-Up API
Zendit Reports API
Zendit Tools API
Zendit Transactions API
Zendit Vouchers API