{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","name":"Voye API documentation","description":"## 🔖 **Purpose of the API**\n\nWith these [Rest API](https://en.wikipedia.org/wiki/REST), you can process new or existing [eSIM](https://en.wikipedia.org/wiki/ESIM) requests with data roaming plans, and obtain information about the user's data plan usages.  \nThe request and response are in [JSON](https://www.json.org/json-en.html).\n\n---\n\n## **Terms dictionary:**\n\n- **Customers** : The end users who will receive the data plan and use the eSIM abroad\n    \n- **Partners** : The Partner distributes eSIMs to its customers using the Voye APIs\n    \n- **BaseUrl** : The URL address you will used as base URL for all your API calls.\n    \n- **`Plan_ID`** **:** Id of the plan, provided by us to be shown on the partner’s site.\n    \n- **`User_ID`** **:** Id of the user/customer on the partner’s site. To be set by the partner.\n    \n- **`Activation_code`**: Partner can create QR code using this code, for installing eSIM on device.\n    \n- **`Order_ID`** **:** Id of order created at our end for records purpose.\n    \n- **`SD`** **:** Service device Id i.e. eSIM’s unique identifier.\n    \n- **`Service_Plan_ID`**: Unique Id of the plans applied on eSIMs.\n    \n\n### Authorization\n\nFor basic authentication we are going to provide the **Username** and **Password** for each partner.  \nVoye will provide the `aes-256-cbc` encryption key for the password, using which the partner will encrypt the password and apply it in headers of the following API’s.\n\n#### Authorization error response\n\n- If empty Username or Password  \n    `{\"success\": false, \"message\": \"Enter Username and Password\"}`\n    \n- If wrong Username or Password  \n    `{\"success\": false, \"message\": \"Invalid Username and Password\"}`\n    \n\n### An general overview of the API flow:\n\n1. Contact the Voye team via [Voyeglobal.com/partners](https://voyeglobal.com/partners/) to get the Username and encrypted Password.\n    \n2. Obtaining a list of Plan IDs from the [<b>Get all plans.</b>](https://api.voyeglobal.com/#b5066d99-e0a0-44e0-bbdd-8bc0263ff3d2)\n    \n3. Place an order and assign **Orders ->** [<b>Assign an eSIM</b>](https://api.voyeglobal.com/view/44251007/2sB2cd6K3H#29f7f70a-ecbb-4ecf-8852-ee9c08c363ad) request.\n    \n4. Provide the user with real-time data plan usage information with the [<b>Usage API</b> ](https://api.voyeglobal.com/view/44251007/2sB2cd6K3H#b1450842-b6f4-4f27-a7f5-e389c1eec557) request.\n    \n5. Notify the user when the package is about to expire/be eliminated using the [<b>Usage Notification API</b>](https://api.voyeglobal.com/view/44251007/2sB2cd6K3H#e0752eaa-9f9a-4d6d-bb99-575382f9792e) and give them an easy way to purchase a new data plan based on their needs.\n    \n6. Create a topup order by ordering a new data plan for an existing eSIM with **Orders ->** [<b>Assign an Data plan (Top-up)</b>](https://api.voyeglobal.com/view/44251007/2sB2cd6K3H#47c68049-fe3e-4923-a1df-e711b806009e) request.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"44251007","team":7433119,"collectionId":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","publishedId":"2sB2cd6K3H","public":true,"publicUrl":"https://api.voyeglobal.com","privateUrl":"https://go.postman.co/documentation/44251007-4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"101FF2"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/207a343c-d6be-43aa-a463-5de910b82947/Vm95ZS1Mb2dvLU9TQiAxLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"F3DDDD"}},{"name":"light","logo":"https://content.pstmn.io/207a343c-d6be-43aa-a463-5de910b82947/Vm95ZS1Mb2dvLU9TQiAxLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"101FF2"}}]}},"version":"8.10.1","publishDate":"2025-05-12T12:19:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/207a343c-d6be-43aa-a463-5de910b82947/Vm95ZS1Mb2dvLU9TQiAxLnBuZw==","logoDark":"https://content.pstmn.io/207a343c-d6be-43aa-a463-5de910b82947/Vm95ZS1Mb2dvLU9TQiAxLnBuZw=="}},"statusCode":200},"environments":[],"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/d755d32860cf9809cfb2193e8a79249b6c3852113f02b8c60bee988502bd1a33","favicon":"https://voyeglobal.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"}],"canonicalUrl":"https://api.voyeglobal.com/view/metadata/2sB2cd6K3H"}