{"info":{"_postman_id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","name":"Voye API documentation","description":"

🔖 Purpose of the API

With these Rest API, you can process new or existing eSIM requests with data roaming plans, and obtain information about the user's data plan usages.
The request and response are in JSON.

Terms dictionary:

Customers : The end users who will receive the data plan and use the eSIM abroad
\n
Partners : The Partner distributes eSIMs to its customers using the Voye APIs
\n
BaseUrl : The URL address you will used as base URL for all your API calls.
\n
Plan_ID : Id of the plan, provided by us to be shown on the partner’s site.
\n
User_ID : Id of the user/customer on the partner’s site. To be set by the partner.
\n
Activation_code: Partner can create QR code using this code, for installing eSIM on device.
\n
Order_ID : Id of order created at our end for records purpose.
\n
SD : Service device Id i.e. eSIM’s unique identifier.
\n
Service_Plan_ID: Unique Id of the plans applied on eSIMs.
\n

Authorization

For basic authentication we are going to provide the Username and Password for each partner.
Voye 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.

Authorization error response

If empty Username or Password
{\"success\": false, \"message\": \"Enter Username and Password\"}
\n
If wrong Username or Password
{\"success\": false, \"message\": \"Invalid Username and Password\"}
\n

An general overview of the API flow:

Contact the Voye team via Voyeglobal.com/partners to get the Username and encrypted Password.
\n
Obtaining a list of Plan IDs from the Get all plans.
\n
Place an order and assign Orders -> Assign an eSIM request.
\n
Provide the user with real-time data plan usage information with the Usage API request.
\n
Notify the user when the package is about to expire/be eliminated using the Usage Notification API and give them an easy way to purchase a new data plan based on their needs.
\n
Create a topup order by ordering a new data plan for an existing eSIM with Orders -> Assign an Data plan (Top-up) request.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"44251007","collectionId":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","publishedId":"2sB2cd6K3H","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"101FF2"},"publishDate":"2025-05-12T12:19:58.000Z"},"item":[{"name":"Plans","item":[{"name":"Get the covered country list","id":"f60ae257-63e9-4b03-b153-fa4e243f7f76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_country_coverage_list","urlObject":{"path":["voye-integrate","v1","get_country_coverage_list"],"host":["{{BaseUrl}}wp-json"],"query":[],"variable":[]}},"response":[{"id":"4cffc159-fabd-42ac-bd2d-85f635f3c932","name":"Get covered countries list Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/get_country_coverage_list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"countries_plans\": [\n {\n \"name\": \"italy\",\n \"country_code\": \"IT\"\n }\n ]\n }\n}"}],"_postman_id":"f60ae257-63e9-4b03-b153-fa4e243f7f76"},{"name":"Get all plans","id":"b5066d99-e0a0-44e0-bbdd-8bc0263ff3d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"lang_code\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_all_country_plans_list","urlObject":{"path":["voye-integrate","v1","get_all_country_plans_list"],"host":["{{BaseUrl}}wp-json"],"query":[],"variable":[]}},"response":[{"id":"3a6debab-028d-405c-a6c3-3c81fad752f9","name":"Get all plans Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"lang_code\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/get_all_country_plans_list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"countries_plans\": [\n {\n \"ID\": \"5323\",\n \"post_title\": \"Italy 7 days 3GB\",\n \"price\": \"9\",\n \"valid_for\": \"7\",\n \"sms\": null,\n \"calls\": null,\n \"international_calls\": null,\n \"data\": \"3\"\n }"},{"id":"0c32d1d7-ab38-4531-8450-65e968214caa","name":"Get all plans no data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"lang_code\" : \"xz\"\n}","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/get_all_country_plans_list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"countries_plans\": []\n }\n}"}],"_postman_id":"b5066d99-e0a0-44e0-bbdd-8bc0263ff3d2"},{"name":"Get specific plans","id":"878d2f1a-350c-46d6-bf43-4b353e7f7530","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_slug\":\"italy\",\n \"lang_code\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_country_plans_list","urlObject":{"path":["voye-integrate","v1","get_country_plans_list"],"host":["{{BaseUrl}}wp-json"],"query":[],"variable":[]}},"response":[{"id":"d61d62cf-79b5-4992-9937-4ff505b3e6d7","name":"Get specific plans Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"destination_slug\":\"italy\",\n \"lang_code\" : \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/get_all_country_plans_list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"coverage\": [\n \"italy\"\n ],\n \"countries_plans\": [\n {\n \"ID\": \"3780\",\n \"post_title\": \"Italy 30 days 25GB\",\n \"price\": \"33\",\n \"valid_for\": \"30\",\n \"sms\": null,\n \"calls\": null,\n \"international_calls\": null,\n \"data\": \"25\"\n },\n {\n \"ID\": \"3781\",\n \"post_title\": \"Italy 30 days 10GB\",\n \"price\": \"19\",\n \"valid_for\": \"30\",\n \"sms\": null,\n \"calls\": null,\n \"international_calls\": null,\n \"data\": \"10\"\n },\n {\n \"ID\": \"3782\",\n \"post_title\": \"Italy 15 days 6GB\",\n \"price\": \"15\",\n \"valid_for\": \"15\",\n \"sms\": null,\n \"calls\": null,\n \"international_calls\": null,\n \"data\": \"6\"\n }"},{"id":"01364e82-0de7-4bc0-88c4-6e0de22733c3","name":"Get specific plans - Days","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_slug\":\"italy\",\n \"lang_code\" : \"en\",\n \"days\" : 30\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_country_plans_list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"coverage\": [\n \"italy\"\n ],\n \"countries_plans\": [\n {\n \"ID\": \"37820\",\n \"post_title\": \"Italy 30 days 25GB\",\n \"price\": \"33\",\n \"valid_for\": \"30\",\n \"sms\": null,\n \"calls\": null,\n \"international_calls\": null,\n \"data\": \"25\"\n },\n {\n \"ID\": \"703470\",\n \"post_title\": \"Italy 30 Days Unlimited Data\",\n \"price\": \"39\",\n \"valid_for\": \"30\",\n \"sms\": null,\n \"calls\": \"\",\n \"international_calls\": null,\n \"data\": \"0\"\n },\n {\n \"ID\": \"1325510\",\n \"post_title\": \"Italy 30 days 15GB\",\n \"price\": \"23\",\n \"valid_for\": \"30\",\n \"sms\": \"\",\n \"calls\": \"\",\n \"international_calls\": \"\",\n \"data\": \"15\"\n }\n ]\n }\n}"},{"id":"b1b60602-3422-4c7b-ad75-02721736da80","name":"Get specific plans - Data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_slug\":\"italy\",\n \"lang_code\" : \"en\",\n \"data\" : 15\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_country_plans_list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"coverage\": [\n \"italy\"\n ],\n \"countries_plans\": [\n {\n \"ID\": \"1325350\",\n \"post_title\": \"Italy 30 days 15GB\",\n \"price\": \"23\",\n \"valid_for\": \"30\",\n \"sms\": \"\",\n \"calls\": \"\",\n \"international_calls\": \"\",\n \"data\": \"15\"\n }\n ]\n }\n}"},{"id":"b8b12f29-a8ac-4167-9667-c1421d601908","name":"Get specific plans - Price","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_slug\":\"italy\",\n \"lang_code\" : \"en\",\n \"price\" : 23\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_country_plans_list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"coverage\": [\n \"italy\"\n ],\n \"countries_plans\": [\n {\n \"ID\": \"70548\",\n \"post_title\": \"Italy 15 Days Unlimited Data\",\n \"price\": \"23\",\n \"valid_for\": \"15\",\n \"sms\": null,\n \"calls\": \"\",\n \"international_calls\": null,\n \"data\": \"0\"\n },\n {\n \"ID\": \"132550\",\n \"post_title\": \"Italy 30 days 15GB\",\n \"price\": \"23\",\n \"valid_for\": \"30\",\n \"sms\": \"\",\n \"calls\": \"\",\n \"international_calls\": \"\",\n \"data\": \"15\"\n }\n ]\n }\n}"},{"id":"2eb19e59-955b-4534-b487-18de25642bee","name":"Get specific plans no data","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_slug\":\"italy\",\n \"lang_code\" : \"xz\"\n}","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/get_country_plans_list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Country plans retrieved successfully.\",\n \"data\": {\n \"countries_plans\": []\n }\n}"}],"_postman_id":"878d2f1a-350c-46d6-bf43-4b353e7f7530"}],"id":"e7270421-8134-4e0c-9161-179d2c477c78","description":"

Get covered country list - The list provides only destinations for which we have plans

Get all plans - List of all plans, including regional and global plans.

Get specific plans - Get a specific plans for a specific destination / region / global.
With filtarion of: Days / Data / Price / Plan type

Plans data structure:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Plan items	Notes
\"ID\"	Package ID
\"post_title\"	Package name
\"price\"	USD
\"valid_for\"	Days
\"sms\"	Unit
\"calls\"	Minutes
\"international_calls\"	Minutes
\"data\"	GB (Gigabyte), if data is 0 = Unlimited plan

Available languages:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Language	Language Code
Arabic	ar
Chinese (Traditional)	zh-hant
Chinese (Simplified)	zh-hans
French	fr
German	de
Hebrew	he
Japanese	ja
Korean	ko
Polish	pl
Portuguese (Brazil)	pt-br
Spanish	es
Turkish	tr
English	en

","_postman_id":"e7270421-8134-4e0c-9161-179d2c477c78","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","name":"Voye API documentation","type":"collection"}}},{"name":"Orders","item":[{"name":"Assign an eSIM","id":"29f7f70a-ecbb-4ecf-8852-ee9c08c363ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_new\": 1,\n \"sd\": null,\n \"plan_id\": 112233,\n \"first_name\": \"CustomerName\",\n \"last_name\": \"CustomerLastName\",\n \"user_email\": \"CustomerEmailAddress@company.com\",\n \"partner_name\": \"Partner_name\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/wp-json/voye-integrate/v1/assign_esim_plan","description":"

This API call ordering a data plan to an eSIM beacuse it's initial order (\"is_new\" : 1 & \"sd\": null) a new eSIM

\n","urlObject":{"path":["wp-json","voye-integrate","v1","assign_esim_plan"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d6e4bf6f-4f36-47c2-b03d-f0f7f646cecf","name":"Assign an eSIM Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_new\": 1,\n \"sd\": null,\n \"plan_id\": 112233,\n \"first_name\": \"Johen\",\n \"last_name\": \"Doe\",\n \"User_email\": \"johndoe@gmail.com\",\n \"Partner_name\": \"Airline\",\n \"lang_code\" : \"en\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/assign_esim_plan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"success\": true,\n\"message\": \"Plan assigned successfully.\",\n\"data\": { \n \"sd\": \"4109874\",\n \"activation_code\" : \"LPA:1$activationCode\" ,\n \"service_plan_id\": \"a8bdcdfc-df0e-4bd5-9a6b-7fd614403096\",\n \"Order_id\": 129266,\n \"esim_url\": \"https://partner.voyeglobal.com/sso-login/?token=%2FJX6HCxBxqdt%2BrhoNnmOCdHBLfMVds8WqC%2FDF8QFsusOk%2BAo2R6fOfQu62pXICEWmuJHbAbPtSsDYzh2vb1QX8A%3D%3D\",\n \"status\": \"Success\",\n \"error_message\": \"\"\n} }\n"},{"id":"89fd3aaa-0540-46fb-badb-f9f05e69d1df","name":"Assign an eSIM Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_new\": 1,\n \"sd\": null,\n \"plan_id\": 112233,\n \"first_name\": \"Johen\",\n \"last_name\": \"Doe\",\n \"User_email\": \"johndoe@gmail.com\",\n \"Partner_name\": \"Airline\"\n}","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/assign_esim_plan"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"InvalidParameter\",\n \"data\": {\n \"error_message\": \" detailed description\"\n }\n}"}],"_postman_id":"29f7f70a-ecbb-4ecf-8852-ee9c08c363ad"},{"name":"Assign an data Plan (top-up)","id":"47c68049-fe3e-4923-a1df-e711b806009e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_new\": 0,\n \"sd\": 4109874,\n \"plan_id\": 112233,\n \"first_name\": \"CustomerName\",\n \"last_name\": \"CustomerLastName\",\n \"user_email\": \"CustomerEmailAddress@company.com\",\n \"partner_name\": \"Partner_name\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/wp-json/voye-integrate/v1/assign_esim_plan","urlObject":{"path":["wp-json","voye-integrate","v1","assign_esim_plan"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"ffbe1406-f209-4b85-9093-df41224f42f4","name":"Assign an Data Plan Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_new\": 0,\n \"sd\": 4109874,\n \"plan_id\": 112233,\n \"first_name\": \"Johen\",\n \"last_name\": \"Doe\",\n \"User_email\": \"johndoe@gmail.com\",\n \"Partner_name\": \"Airline\"\n }","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/assign_esim_plan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Plan assigned successfully.\",\n \"data\": {\n \"sd\": \"ESIM123456\",\n \"activation_code\": \"LPA://asdasdhd\",\n \"service_plan_id\": 101,\n \"Order_id\": 32432,\n \"status\": \"Success\",\n \"error_message\": \"\"\n }\n}"},{"id":"7d75109d-7c73-4855-b7e3-d17f954588a1","name":"Assign an Data Plan Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"is_new\": 0,\n \"sd\": 4109874,\n \"plan_id\": 112233,\n \"first_name\": \"Johen\",\n \"last_name\": \"Doe\",\n \"User_email\": \"johndoe@gmail.com\",\n \"Partner_name\": \"Airline\"\n }","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/assign_esim_plan"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\"success\": false,\n \"message\": \"InvalidParameter\",\n \"data\": { \n \"error_message\": \" detailed description\"\n }\n}\n\n"}],"_postman_id":"47c68049-fe3e-4923-a1df-e711b806009e"},{"name":"Get plan details","id":"ca9c7d3d-8f76-4c57-82c3-22d203b49995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\" : 129876\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_order_details","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","name":"Voye API documentation","type":"collection"}},"urlObject":{"path":["voye-integrate","v1","get_order_details"],"host":["{{BaseUrl}}wp-json"],"query":[],"variable":[]}},"response":[{"id":"6cd80be2-3b54-457a-ac52-117e5a3647c2","name":"Get previous order data Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\" : 129876\n}\n","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_order_details"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Order retrieved successfully.\",\n \"data\": {\n \"sd\": \"4109874\",\n \"service_plan_id\": \"a8bdcdfc-df0e-4bd5-9a6b-7fd614403096\",\n \"activation_code\": \"LPA:1$activationCode\",\n \"Order_id\": 129876,\n \"esim_url\": \"https://partner.voyeglobal.com/sso-login/?token=%2FJX6HCxBxqdt%2BrhoNnmOCdHBLfMVds8WqC%2FDF8QFsusOk%2BAo2R6fOfQu62pXICEWmuJHbAbPtSsDYzh2vb1QX8A%3D%3D\",\n \"order_status\": \"processing\",\n \"status\": \"Success\",\n \"error_message\": \"\"\n }\n}"},{"id":"e9f73937-d19a-4b7b-a941-fb4007d5fe1a","name":"Get previous order data Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\" : 129876\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/get_order_details"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"InvalidOrder\",\n \"data\": {\n \"error_message\": \"Order not found\"\n }\n}"}],"_postman_id":"ca9c7d3d-8f76-4c57-82c3-22d203b49995"},{"name":"Cancel plan order","id":"9aece00f-4344-48a1-b5e6-2df2afbf4d4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\" : 129876,\n \"partner_name\" : \"PartnerName\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}wp-json/voye-integrate/v1/cancel_plans","urlObject":{"path":["voye-integrate","v1","cancel_plans"],"host":["{{BaseUrl}}wp-json"],"query":[],"variable":[]}},"response":[{"id":"3ed6dba6-0f5d-444b-87d3-3e4ae2cd0878","name":"Cancel Plan Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\" : 129876,\n \"partner_name\" : \"Airline\",\n \"lang_code\" : \"en\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/cancel_plans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"PlanDeleted\",\n \"data\": {\n \"error_message\": \"Plan deleted successfully\"\n }\n}"},{"id":"0a595b95-f8a1-463a-86c8-713d4f37f94f","name":"Cancel Plan Forbidden","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\" : 129876,\n \"partner_name\" : \"PartnerName\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/cancel_plans"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"FailedToCancelPlan\",\n \"data\": {\n \"error_message\": \"Plan is Active it cannot be cancelled.\"\n }\n}"},{"id":"f8fdf0cc-db77-4373-b6a9-8451cd87938a","name":"Cancel Plan Not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"order_id\" : 129876,\n \"partner_name\" : \"PartnerName\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/cancel_plans"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"OrderNotFound\",\n \"data\": {\n \"error_message\": \"Order not found\"\n }\n}"}],"_postman_id":"9aece00f-4344-48a1-b5e6-2df2afbf4d4d"}],"id":"f97371ce-4277-4216-bf8b-0cc2f6a5b458","description":"

Request:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
is_new	Boolean	Yes	Indicates whether this is a new eSIM request (0 for existing, 1 for new).
sd	Int	Initial - No Top up - Yes	The eSIM ID (service device) provided by the user (used for top-up recharge). *For Initial order - use “null”
plan_id	Int	Yes	The ID of the data plan on the partner site. Voye will provide plan_ids for plans.
first_name	string	Yes	Users first name. If the partner doesn't want to share data. Share encrypted form.
last_name	string	Yes	Users last name. If the partner doesn't want to share data. Share encrypted form.
user_email	string	Yes	Users email. If the partner doesn't want to share data. Share encrypted form of email.
partner_name	string	Yes	Partner’s unique Identifier

Response:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
sd	Int	The unique identifier for the eSIM
activation_code	String	Url for eSIM activation (QR code)
service_plan_id	Int	Unique ID of the data plan on eSIM
order_id	Int	Order Id of the order on Voye
esim_url	String	This link is dedicated to the user's \"account\" with his eSIM and plan
status	Boolean	True , False
error_message	String	Error details in case of a failure

Cancel a plan

Voye validates the status of the plan before canceling it.
It is forbidden to cancel a plan that has already been activated.

*Plan active means that the end customer has already installed an eSIM in his device and is connected to the Internet at the destination of the plan.

\n","_postman_id":"f97371ce-4277-4216-bf8b-0cc2f6a5b458","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":true,"source":{"_postman_id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","id":"4b33a6b3-179a-4b05-bd7a-ba6a3a2ef2c7","name":"Voye API documentation","type":"collection"}}},{"name":"Usage API","item":[{"name":"Usage API","id":"b1450842-b6f4-4f27-a7f5-e389c1eec557","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sd\" : \"4109786\"\n}","options":{"raw":{"language":"json"}}},"url":"{{BaseUrl}}/wp-json/voye-integrate/v1/get_esim_plan_usage","description":"

This API call provides eSIM data usage, and plan details for effective management.
It fetches plan usage details of eSIMs.

\n","urlObject":{"path":["wp-json","voye-integrate","v1","get_esim_plan_usage"],"host":["{{BaseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a2227fb0-652d-49cd-b792-1594cf0103b0","name":"Usage API","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"SD\": \"4109786\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://voyeglobal.com/wp-json/voye-integrate/v1/get_esim_plan_usage"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Data fetched successfully.\",\n \"data\": {\n \"sd\": 4109786,\n \"simActivated\": 1,\n \"assignedPlans\": [\n {\n \"service_plan_id\": \"a8bdcdfc-df0e-4bd5-9a6b-7fd614403096\",\n \"plan_id\": \"112233\",\n \"plan_active\": \"\",\n \"usage_data\": \"\",\n \"usage_data_mb\": \"\",\n \"status\": \"Not Active\",\n \"total_data\": 1,\n \"valid_for\": 2,\n \"percentage\": \"0.00\",\n \"data_left\": \"1GB\",\n \"activation_date\": \"\",\n \"expire_data\": \"27/12/2024\"\n },\n {\n \"service_plan_id\": \"1ff0d839-1327-4022-a0ab-51eeef1d1c25\",\n \"plan_id\": \"112233\",\n \"plan_active\": \"\",\n \"usage_data\": \"\",\n \"usage_data_mb\": \"\",\n \"status\": \"Not Active\",\n \"total_data\": 6,\n \"valid_for\": 15,\n \"percentage\": \"0.00\",\n \"data_left\": \"6GB\",\n \"activation_date\": \"\",\n \"expire_data\": \"09/01/2025\"\n },\n {\n \"service_plan_id\": \"e4b96588-98e0-49f4-80b9-c9f3c58bf0d1\",\n \"plan_id\": \"112233\",\n \"plan_active\": \"\",\n \"usage_data\": \"\",\n \"usage_data_mb\": \"\",\n \"status\": \"Not Active\",\n \"total_data\": 1,\n \"valid_for\": 7,\n \"percentage\": \"0.00\",\n \"data_left\": \"1GB\",\n \"activation_date\": \"\",\n \"expire_data\": \"01/01/2025\"\n }\n ]\n }\n}\n"},{"id":"a343d177-d96c-441a-be06-f8b529f4bfc8","name":"Usage API Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"sd\" : \"4109786\"\n}","options":{"raw":{"language":"json"}}},"url":"https://do.voyeglobal.com/wp-json/voye-integrate/v1/get_esim_plan_usage"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\"success\": false,\n \"message\": \"eSIMNotFound\",\n\"data\": { \n\n \"error_message\": \" detailed description\"\n}}\n"}],"_postman_id":"b1450842-b6f4-4f27-a7f5-e389c1eec557"}],"id":"9cb1a906-3340-4755-a913-612c4fe387aa","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
sd	Int	The eSIM number ( unique identifier for the eSIM )

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
success	Boolean	\"success\" indicates whether the operation was successful, with true for success and false for failure
message	String	Message about the operation's success or failure.
sd	Int	Unique ID for the eSIM.
simActivated	Int	Indicates if the SIM is activated (1 for active, 0 for not).
assignedPlans	Array	List of plans assigned to the eSIM with their details.

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f02399c8-fc8d-48eb-8ca8-d8628aad9ff8","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"12eebc62-9df2-461a-8f40-fe2b815b92ec","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"9cb1a906-3340-4755-a913-612c4fe387aa"},{"name":"Usage Notifications","item":[],"id":"e0752eaa-9f9a-4d6d-bb99-575382f9792e","description":"

As soon as the customer's plan reaches 80% and 99% usage.

By default, we send usage notifications through our white labels via emails or WhatsApp messages, unless the partner requests to handle it himself via webhooks, in which case follow the steps below.

Usage Notification API:

Purpose:
This Webhook provides Usage notification when esim’s plan is going to be exceeded.
The request and response are in JSON.

*The partner needs to provide the webhook endpoint to which we will direct our request.*

Request (From Voye’s end ) :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
sd	int	The eSIM ID (service device)
Quota	int	The total data in the plan (bytes)
Usage	string	The data usage till now (bytes)
plan_id	string	The ID of the data plan on the partner site. Voye will provide plan_ids for plans.
service_plan_id	string	Unique ID of the data plan on eSIM

It's the partner responsbality to send the customer the usage notification

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"847d9dea-d9e9-4544-910f-d881ce6828cb","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"594a904a-668f-4f5d-8dd8-275dd3be52a7","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"e0752eaa-9f9a-4d6d-bb99-575382f9792e"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{UserName}}"},{"key":"password","value":"{{Password}}"}]}},"event":[{"listen":"prerequest","script":{"id":"2090ad0f-90cb-415f-934f-0ebc3528294e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d34900a2-1236-44f3-bff3-1b5baa9e9703","type":"text/javascript","exec":[""]}}],"variable":[{"key":"BaseUrl","value":"{{BaseUrl}}"},{"key":"UserName","value":"{{UserName}}","type":"default"},{"key":"Password","value":"{{Password}}","type":"default"}]}