Skip to content
Preview. The Partners API is not live yet, so details on this page can change before launch.

About the Partners API

The eSIMify Partners API lets a travel business sell eSIMs under its own brand: a travel agency, a corporate travel desk, a booking app, an airline. Your customer stays in your product from the plan search to the installed eSIM. eSIMify supplies the plans, issues the eSIMs and keeps them connected.

The API is called from your server. It is white-label: eSIMify does not email or message your customers about API orders, and does not email you about them either. What your customers see, and when, is up to you.

  1. Your customer picks a destination in your app.
  2. You list the packages for that destination from the catalogue and show them with your own pricing. A package is one plan: a data allowance for a country or region, valid for a number of days.
  3. The customer pays you. You place an order with eSIMify. Its total is charged to your partner balance.
  4. eSIMify returns the eSIM. You show its QR code or a one-tap install link.
  5. If the customer needs more data, you top up the same eSIM.
  6. Webhooks tell your server when an order finishes, when the eSIM is first used, when data runs low and when the plan ends.
Part What it is Reference
Catalogue The packages you can sell, per country and region, with data allowance, validity and price for your account. Catalogue
Balance The partner balance your orders are charged to. The Business portal calls it your wallet. Balance
Orders A purchase of one or more eSIMs. An order is safe to retry. Orders
eSIMs The eSIM itself: install details, status, data used and data left. eSIMs
Top-ups A package added to an eSIM your customer already has. Top-ups
Events A record of what happened, sent to you as webhooks and kept for 30 days. Events

The Objects page describes every field.

Sandbox Live
Key Starts with sk_test_ Starts with sk_live_
Catalogue and prices Same as live Your real catalogue
eSIMs Test eSIMs that cannot be installed. Their ICCIDs start with 8999999. Real eSIMs
Balance A virtual balance of 1000000.00 INR that refills itself Your partner balance
Webhooks Sent to your test-mode endpoints Sent to your live-mode endpoints
eSIM status and usage Changed by you, with the simulate endpoint Reported by the mobile network, with a delay

Build and test against the sandbox first. Switching to live is a change of key, not a change of code.

Keys, webhook endpoints and request logs are in the Business portal at business.esimify.in, under Developers. It has five tabs: Overview, API keys, Webhooks, Logs and Activity. If the page says API access is not enabled for your account, email support@esimify.in.

Your balance is under Wallet, and your low-balance threshold and notification addresses are under Settings.