FAQ
Do I need different code for the sandbox and for live?
Section titled “Do I need different code for the sandbox and for live?”No. The base URL, paths, fields and errors are the same. The key decides the mode: sk_test_ for the sandbox, sk_live_ for live. The only sandbox-only parts are the customer_ref triggers and the simulate endpoint.
Can I call the API from my mobile app or website?
Section titled “Can I call the API from my mobile app or website?”No. Call it from your server. A key inside an app or a web page can be read by anyone, and a key can spend your balance. See Security.
Which currency are prices in?
Section titled “Which currency are prices in?”Amounts in the API are in INR. For anything about other currencies, email support@esimify.in or ask your eSIMify account manager.
How do I add money to my balance, and what are the payment terms?
Section titled “How do I add money to my balance, and what are the payment terms?”Add funds in the Business portal under Wallet, with Recharge wallet. A card or UPI payment is credited straight after payment. A bank transfer is credited once it is confirmed. The portal calls your balance your wallet. Credit terms, if any, are agreed with eSIMify.
If a recharge payment is later refunded or charged back, the same amount is taken off your balance.
What should I charge my customer?
Section titled “What should I charge my customer?”That is your decision. price is what a package costs you: the eSIMify retail price less your partner discount. retail_price is what eSIMify sells the same package for, as a reference point. See How the catalogue and prices work.
Does eSIMify email or message my customer?
Section titled “Does eSIMify email or message my customer?”No. Orders and top-ups placed through the API send no email and no message to your customer, and none to you. You deliver the eSIM under your own brand. See Delivering eSIMs.
The customer details you can send with an order are shown to your staff in the Business portal. eSIMify never uses them to contact the traveller.
Orders your staff place in the Business portal are different: there the portal can email the eSIM, if your staff choose that.
How long does an order take?
Section titled “How long does an order take?”Most orders are completed in the response to POST /v1/orders. The call waits up to about 20 seconds for the eSIMs, so set your HTTP client timeout to at least 30 seconds. An order that is not finished by then comes back as processing and finishes in the background. This is more likely for large quantities. An order that makes no progress for 15 minutes is settled automatically: the eSIMs that were not issued are refunded. We do not publish a guaranteed time. Build for both cases: see Handling processing.
Can I cancel or refund an order through the API?
Section titled “Can I cancel or refund an order through the API?”Version 1 has no endpoint for cancelling or refunding an order. When an order fails, or completes only in part, the amount for the eSIMs that were not issued is returned to your balance and shown in refunded.
An unused eSIM can be cancelled in the Business portal, or by eSIMify support at your request. It is refunded only when the mobile network provider confirms the cancellation and reports that the eSIM was not used. An eSIM that has had a top-up cannot be cancelled. A cancelled order or eSIM shows the status cancelled in the API. No webhook is sent for it.
Can every eSIM be topped up?
Section titled “Can every eSIM be topped up?”No. Always call GET /v1/esims/{iccid}/topup-packages before you offer a top-up. An empty list, or 409 esim_not_topupable, means there is nothing to offer. An expired or cancelled eSIM cannot be topped up.
What happens if my server misses a webhook?
Section titled “What happens if my server misses a webhook?”A delivery is attempted up to 8 times over about 45 hours. Every stored event is also kept for 30 days, and you can read it with GET /v1/events. You can retry a failed delivery by hand in the portal. See Webhooks.
One exception: live eSIM events (esim.*) are produced only while your account has an enabled live endpoint. See eSIM events in live.
How fresh is the data usage on an eSIM?
Section titled “How fresh is the data usage on an eSIM?”GET /v1/esims/{iccid} returns the latest usage eSIMify has. For a live eSIM it asks the mobile network for a fresh figure, at most once a minute. It is not a live meter: usage reaches us from the network with some delay. Usage events usually arrive within 15 minutes and can take up to about an hour. Some networks report no usage at all. Do not promise your customer an exact figure.
What are the limits?
Section titled “What are the limits?”- 120 requests a minute for each key, of which 30 can be
POST. - 1 to 50 eSIMs in one order.
- Up to 10 API keys and 5 webhook endpoints in each mode.
- A request body of up to 64 KB.
- Up to 20 entries in a key’s IP allowlist.
If you need a higher limit, email support@esimify.in or ask your eSIMify account manager.
Is there an SDK?
Section titled “Is there an SDK?”There is no official SDK in the preview. The API is plain JSON over HTTPS, and every reference page has examples in curl, Node, PHP and Python. You can also import the OpenAPI description, or the Postman collection with its environment file.
Is there an uptime guarantee or a support SLA?
Section titled “Is there an uptime guarantee or a support SLA?”These docs do not set out service levels, support hours or commercial terms. Ask your eSIMify account manager.
What happens if my account is deactivated?
Section titled “What happens if my account is deactivated?”Every API call, with test and live keys, answers 403 account_inactive. You cannot place orders, top up or read eSIMs, and webhooks stop: deliveries that were waiting are marked failed and no new events are produced. The Business portal refuses the account as well. Deactivating an account does not by itself switch off eSIMs your customers already have. Email support@esimify.in or ask your eSIMify account manager.
Why does the list show a different package id for the same plan?
Section titled “Why does the list show a different package id for the same plan?”The list shows one package for each destination, data size and validity. The package behind that slot can change when a better offer becomes available. An id you stored earlier keeps working while that package is on sale. See How the catalogue and prices work.
How do I report a security problem?
Section titled “How do I report a security problem?”Tell your eSIMify account manager. If you do not have one, email support@esimify.in and ask for the security contact. Give the steps to reproduce the problem, and do not include live API keys.
When will the API leave preview?
Section titled “When will the API leave preview?”There is no published date. Changes are listed in the changelog.