{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"98788d5a-8083-4aa1-affb-9553291db0e3","name":"eSIM Access API","description":"# Partner API\n\nDeliver eSIM data plan packages via the [eSIM Access](https://esimaccess.com) HTTP API. [Step by step overview](https://docs.google.com/spreadsheets/d/1MhRUxoC0_wlXu-FxXDP-2V9bk_1i3r8MBmISyjpaznw/edit?usp=sharing).\n\n## Quick Start\n\n1. [Create an account](https://console.esimaccess.com/login) at **eSIM Access**\n    \n2. [Deposit funds](https://console.esimaccess.com/partner-bill/index) for testing and refunding\n    \n3. [Copy your AccessCode](https://console.esimaccess.com/developer/index)\n    \n4. Add your _AccessCode_ below and run in your terminal or powershell to make your first API call\n    \n\n``` bash\ncurl --location --request POST 'https://api.esimaccess.com/api/v1/open/balance/query' \n--header 'RT-AccessCode: YOUR_ACCCESS_CODE' \n--data ''\n\n ```\n\n``` powershell\ncurl -Uri \"https://api.esimaccess.com/api/v1/open/balance/query\" `\n     -Method POST `\n     -Headers @{\"RT-AccessCode\"=\"YOUR_ACCESS_CODE\"} `\n     -Body \"\"\n\n ```\n\n#### Version - V1\n\nVersion 1 - OCT 11, 2022 - Initial Release\n\nVersion 1.1 - JUN 6, 2023 - Updates:\n\n- Single Profile ordering changed to batch Profile ordering \\[via Order Profiles request\\]\n    \n- Offline post-paying changed to online pre-paying \\[via Order Profiles request\\]\n    \n- esim/list endpoint removed, status function found in esim/query\n    \n- Cancel, Suspend, Unsuspend and Revoke functions added\n    \n- Country filter added to Query All Data Packages\n    \n- Webook for order status checking added\n    \n\nVersion 1.2 - JUL 26, 2023 - Updates:\n\n- Added Top Up endpoint for adding data to existing eSIM profiles\n    \n- Query available Top Up plans with `iccid` or `packageCode`\n    \n- `Price` and `amount` optional when ordering a profile\n    \n\nVersion 1.3 - DEC 12, 2023 - Updates:\n\n- Adds `slug` as an alias to package code\n    \n- Adds additional package data like `speed`, `network`, and `favorite`\n    \n\nVersion 1.4 Mar 12, 2024 - Updates:\n\n- Add SMS send to `iccid` ability\n    \n- Adds ability to write webhooks\n    \n\nVersion 1.5 July 28, 2024 - Updates:\n\n- Adds [daypass plans](https://esimaccess.com/docs/unlimited-day-pass-plans/) with `periodNum` parameter in Order Profiles\n    \n- Adds rate limit of 8 requests per second\n    \n\nVersion 1.6 Dec 20, 2024 - Updates:\n\n- Adds fields `supportTopUpType` and `ipExport`\n    \n\nUpdate Mar 8, 2025\n\n- Adds additional webhook for low balance now at 25% and 10% remaining\n    \n- Adds balance check endpoint with last updated date\n    \n\nUpdate Mar 19, 2025\n\n- Adds two new enpoints for [balance check](https://docs.esimaccess.com/#47388564-1c15-4ee3-9375-12dac830cb7a) and [current regions](https://docs.esimaccess.com/#756ec9fa-d16e-4366-98a8-8bad806f9d1a)\n    \n\nUpdate May 28, 2025\n\n- Add new webhooks - `SMDP_EVENT` which give SM-DP+ server events\n    \n\nUpdate July 24, 2025\n\n- Top Up packages can be added after esim is created.\n    \n\nUpdate Dec 2, 2025\n\n- Adds `datatype` search `fuppolicy` result when viewing data packages.\n    \n\nUpdate Apr 1, 2026\n\n- Add support for Day Pass Plan top up\n    \n\n### Environments and Endpoints\n\n#### Sandbox:\n\nThere is no Sandbox environment. Cancel eSIM orders as needed in our live environment. [Request](https://esimaccess.com/contact/) funds for testing.\n\n#### Production:\n\n`https://api.esimaccess.com`\n\nImage assets:\n\n`https://p.qrsim.net/`\n\n### Authentication\n\nRequst your API keys in your [online account.](https://console.esimaccess.com/)\n\n### Standards\n\nTime codes are presented in UTC. Country codes use Alpha-2 ISO. Data values are in Bytes.\n\n### Status\n\n[Server status](https://esimaccess.statuspage.io/) tracked via postman monitors.\n\n### Rate Limit\n\n8 API request per second are allowed.\n\n### Error Codes\n\n| Code | Message |\n| --- | --- |\n| 000001 | Server error |\n| 000101 | Request header (mandatory) is null |\n| 000102 | Wrong request header format |\n| 000103 | This https request method (get/post ) is not supported |\n| 000104 | Request in invalid JSON format |\n| 000105 | Request parameters (mandatory) are not contained |\n| 000106 | Request parameter (mandatory) is null |\n| 000107 | The length of the request parameter does not meet the requirement. |\n| 101001 | The timestamp of the request has expired. |\n| 101002 | This IP is in the blocklist. |\n| 101003 | Request signature mismatch. |\n\n| 200002 | This operation is not allowed due to the order status. |\n| --- | --- |\n| 200005 | Package `price` error. Check price. |\n| 200006 | Total order price `amount` is wrong. Check prices. |\n| 200007 | Insufficient account balance |\n| 200008 | Order parameters error, please contact customer service. |\n| ​​200009 | Abnormal order status |\n| ​​200010 | Profile is being downloaded for the order. |\n| 200011 | Insufficient available Profiles for the package, please contact the customer service. |\n| 310201 | The bundle.code does not exist. |\n| 310211 | The data_plan_location.id does not exist. |\n| 310221 | The currencyId does not exist. |\n| 310231 | The carrierId does not exist. |\n| 310241 | The `packageCode` does not exist. |\n| 310243 | The package does not exist. |\n| 310251 | The vendor does not exist. |\n| 310272 | The orderNo does not exist. |\n| 310403 | The ICCID does not exist in the order. |\n| 900001 | The system is busy, please try again later. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11154627","team":960121,"collectionId":"98788d5a-8083-4aa1-affb-9553291db0e3","publishedId":"2s93mBxf3q","public":true,"publicUrl":"https://docs.esimaccess.com","privateUrl":"https://go.postman.co/documentation/11154627-98788d5a-8083-4aa1-affb-9553291db0e3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Wholesale, white-label eSIM reseller API.  Wholesale roaming data for over 100 countries.  Use API to order, check status, top up, cancel and suspend. "},{"name":"title","value":"eSIM Access API for resellers"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/ac6e69f7-4d87-4782-8596-c8abd7b66042/U2l0ZV9GYXZpY29uX2xvZ28ucG5n","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/ac6e69f7-4d87-4782-8596-c8abd7b66042/U2l0ZV9GYXZpY29uX2xvZ28ucG5n","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-06-27T15:51:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"eSIM Access API for resellers","description":"Wholesale, white-label eSIM reseller API.  Wholesale roaming data for over 100 countries.  Use API to order, check status, top up, cancel and suspend. "},"logos":{"logoLight":"https://content.pstmn.io/ac6e69f7-4d87-4782-8596-c8abd7b66042/U2l0ZV9GYXZpY29uX2xvZ28ucG5n","logoDark":"https://content.pstmn.io/ac6e69f7-4d87-4782-8596-c8abd7b66042/U2l0ZV9GYXZpY29uX2xvZ28ucG5n"}},"statusCode":200},"environments":[{"name":"Pub Env","id":"1a6283c8-0422-49ea-adea-0919cf18c0cc","owner":"11154627","values":[{"key":"host","value":"https://api.esimaccess.com","enabled":true,"type":"default"},{"key":"accessCode","value":"","enabled":true,"type":"default"},{"key":"secretKey","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b3b4b7aed57d6917e4f82def8e22c85e34ff0d1655934a142caaf35984f6e138","favicon":"https://esimaccess.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Pub Env","value":"11154627-1a6283c8-0422-49ea-adea-0919cf18c0cc"}],"canonicalUrl":"https://docs.esimaccess.com/view/metadata/2s93mBxf3q"}