{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"35357fad-03ef-4511-8ec5-8e3e915db3e5","name":"Roumio - WEB API","description":"# Documentation\n\nWelcome to the official **Roumio** documentation! Here, you’ll find everything you need to integrate, manage, and optimize Roumio for your applications. If you have any questions or run into difficulties, don’t hesitate to reach out to our support team or check the FAQs.\n\n## Table of Contents\n\n1. Overview\n    \n2. Getting Started\n    \n3. Key Concepts\n    \n4. API Reference\n    \n5. Contact & Support\n    \n\n## Overview\n\nRoumio is a platform that streamlines global connectivity and management of telecommunication networks. Whether you’re looking to orchestrate remote communication for IoT devices or power user-focused mobile apps, Roumio offers a suite of tools to simplify provisioning and lifecycle management.\n\n### Features\n\n- **Global Connectivity**: Access robust connectivity options worldwide.\n    \n- **Scalable Integration**: Roumio fits your needs—from small startups to enterprise-level integrations.\n    \n- **Real-Time Analytics**: Monitor usage, gather insights, and optimize performance.\n    \n- **Flexible APIs**: RESTful endpoints for fast, reliable integration with any tech stack.\n    \n\n### How It Works\n\n1. **Provision**: Use Roumio to allocate SIM resources for your users or devices.\n    \n2. **Manage**: View and control all active connections in the Roumio dashboard.\n    \n3. **Analyze**: Gather usage data and performance metrics to optimize your operations.\n    \n\n## Getting Started\n\nHere’s a quick roadmap for new users:\n\n1. **Sign Up**  \n    Contact Roumio for account creation. Once you’ve verified your email, you’ll gain access to the Roumio Dashboard.\n    \n2. **Obtain API Credentials**\n    \n    - Go to **Developer Settings** → **API Keys**.\n        \n    - Generate a new API key (or use an existing one).\n        \n    - Store your credentials securely; you’ll need them for the API requests.\n        \n3. **Review Documentation**  \n    Familiarize yourself with the API Reference.\n    \n\n## Key Concepts\n\nBefore diving into the technical details, here are some core concepts to keep in mind:\n\n1. **Roumio Profiles**  \n    Each device or user under your account may have a unique Roumio profile, which stores connectivity settings, usage limits, and other relevant metadata.\n    \n2. **Activation and Deactivation**\n    \n    - **Activation**: Enabling Roumio connectivity for a device or user.\n        \n    - **Deactivation**: Temporarily suspending or permanently stopping the service.\n        \n3. **Billing Cycles**  \n    Roumio supports monthly, annual, or pay-as-you-go billing. Understand your plan’s specifics to avoid disruptions or overages.\n    \n4. **Usage Metrics**  \n    Metrics include data consumption, session durations, and more. These are available in near-real time through the dashboard and the API.\n    \n\n# API Reference\n\nRoumio provides a RESTful API designed to be simple yet comprehensive. Below is a quick overview; for a full list of endpoints, please refer to our complete API docs.\n\nBase URL\n\n```\nhttps://platform.roumio.com/v1\n\n ```\n\n### Authentication\n\nAll requests must include an `Authorization` header containing your API key or a API Secret.\n\nFor example:\n\n```\nAuthorization: YOUR_API_KEY\n\n ```\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| 200002 | This operation is not allowed due to the order status. |\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. |\n\n### Get All Data Packages\n\n#### URL\n\n```\nhttps://platform.roumio.com/v1/package/list\n\n ```\n\nRequest a list of all the available data packages offered. Optionally filter by country or region.\n\nAdditionaly request all of the Top Up plans available for a specific `packageCode` , `slug` or `ICCID`. Specific top ups work with specific plans. In general, countries can be reloaded with same country top up and region with same region top up.\n\n#### Request Parameters\n\n``` json\n{\n    \"locationCode\": \"\",\n    \"type\":\"\",\n    \"slug\":\"NA-3_1_7\",\n    \"packageCode\":\"\",\n    \"iccid\":\"\"\n}\n\n ```\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `locationCode` | String | optional | Filter by Alpha-2 ISO Country Code  <br>`!RG` = Regional  <br>`!GL` = Global | `AZ`  <br>`!GL`  <br>`!RG` |\n| `type` | String | optional | `BASE` - Default product list  <br>`TOPUP` - Top up product list | `BASE`  <br>`TOPUP` |\n| `packageCode` | String | optional | Used with `TOPUP` to view top up package for a `packageCode` | `AZ016` |\n| `slug` | String | optional | `slug` is alias of`packageCode` | `AU_1_7` |\n| `iccid` | String | optional | Include `iccid` with `TOPUP` to see available TOPUP plans | `48584984747372838` |\n\n#### Response Parameters\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `success` | String | required | `true`: succeeded `false`: failed | `true` |\n| `errorCode` | String | optional | `null` or `0` when successful. Error code when failed. | `null` |\n| `errorMessage` | String | optional | Error code explanation | `null` |\n| `obj` | Object | optional | `null` : failed. Success includes: `packageList` |  |\n\n| Domain | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `packageList` | List | required | Available data packages, including: `packageCode` `name` `price` `currencyCode` `volume` `unusedValidTime` `duration` `durationUnit` `location` `description` `activeType` |  |\n| `packageCode` | String | required | Package code | `JC016` |\n| `slug` | String | required | Package alias | `AU_1_7` |\n| `name` | String | required | Package name | `Asia 11 countries 1GB 30 Days` |\n| `price` | Integer | required | Package price, value (value \\* 100 | 15,7 = 1570) |\n| `currencyCode` | String | required | Currency code | `USD` |\n| `volume` | Long | required | Data volume (in mega bytes) of the package | `1024` |\n| `smsStatus` | Integer | required | `0`.SMS not supported `1`.API AND mobile phones SMS delivery `2`.API SMS delivery only | `0` |\n| `dataType` | Integer | required | `1` fixed amount  <br>`2` reset daily unlimited FUP`1` | `1` |\n| `unusedValidTime` | Integer | required | Time till package invalid | `30` |\n| `duration` | Integer | required | Plan validity peirod | `1` |\n| `durationUnit` | String | required | Time unit, used in `unusedValidTime`/`duration` | `DAY` |\n| `location` | String | required | Alpha-2 ISO Country Code of package use | `CN,HK,ID,JP,MO,MY,PH,SG,KR,TW,TH,IN,VN,SA,KH,PK,LK` |\n| `description` | String | required | Description of the data package | `Asia 11 countries` |\n| `activeType` | Integer | required | Activation type: `1`: First installation.  <br>`2`: First network connection. | `1` |\n| `favorite` | Boolean | required | Favorited plan in console | `false` |\n| `speed` | String | required | Network speed | `3G/4G` |\n| `locationNetworkList` | Array | required | `locationName` , `locationLogo` , | `Spain`  <br>`/img/es.png` |\n| `operatorList` | Array | required | `operatorName`,  <br>`networkType` | `T-Mobile 4G/5G` |\n| `ipExport` | String | required | Data traffic exit country | `HK` |\n| `supportTopUpType` | Boolean | required | Top up support `1` = no `2` = yes | `2` |\n\n### Order eSIM\n\n#### URL\n\n```\nhttps://platform.roumio.com/v1/esim/order\n\n ```\n\nOrder profiles individualy. After successful ordering, the SM-DP+ server will return the `OrderNo` and allocate profiles asynchronously for the order.\n\nWhen placing an order, include a **unique** **`transactionId`** for each request (any duplicate `transactionId` will be treated as the same order).\n\nSpecify the **`packageCode`** or **slug** of the data package(s) you’re purchasing, along with the **quantity** for each. If you’re ordering a **daily plan**, you may also provide the **`periodNum`** to indicate the number of days the plan should cover.\n\nA successful order will generate an `orderNo`.\n\n#### Request Parameters\n\n``` json\n{\n    \"transactionId\":\"your_txn_id\",\n    \"amount\":15000,\n    \"packageInfoList\": [{\n        \"packageCode\":\"7aa948d363\",\n        \"count\":1,\n        \"price\":1500,\n    }]\n}\n\n ```\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `transactionId` | String | required | User generated unique transaction ID. Max 50 chars, utf8mb4. If the request is retired, it needs to be contained; otherwise, a new transaction will be created. | `ABC-210-2s7Fr` |\n| `packageInfoList` | List | required | `packageCode` or `slug` , `count` , `price` |  |\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `packageCode` | String | required | Order with `slug` or `packageCode` | `AU_1_7`  <br>`JC016` |\n| `count` | Integer | required | Currently we support only 1 | `1` |\n| `periodNum` | Integer | optional | Days of a daily plan. From 1-365. | `7` |\n\n#### Response Parameters\n\n``` json\n{\n    \"errorCode\": null,\n    \"errorMsg\": null,\n    \"success\": true,\n    \"obj\": {\n        \"orderNo\": \"B23051616050537\"\n        \"transactionId\": \"Your_txn_id\"\n    }\n}\n\n ```\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `success` | String | required | `true`: success `false`: failed | `true` |\n| `errorCode` | String | optional | `null` or `0` when successful. Error code when failed. | `null` |\n| `errorMessage` | String | optional | Error code explanation | `null` |\n| `obj` | Object | optional | Includes: `orderNo` |  |\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `orderNo` | String | required | Order number | `B22102010075311` |\n\n### Query All Allocated eSIMs\n\n#### URL\n\n```\nhttps://platform.roumio.com/v1/esim/query\n\n ```\n\nQuery all eSIM profile details allocated to partner and their status.\n\nAvaible to filter by `orderNo` , `iccid` or between `startTime` and `endTime` range with paging options.\n\nUse `orderNo`,to request newly orderd eSIMs. The response will return the eSIM payload after all the allocated profiles are asynchronously allocated by the server. Expect times wait times of up to 30 seconds.\n\nUse `iccid` to request the status of an eSIM including it's current `orderUsage` and `eSIMStatus`.\n\nIf the profiles are not ready for download, the error will be returned (error code will be `200010`, meaning SM-DP+ is still allocating profiles for the order).\n\n##### Understanding eSIM Profile Status\n\nResults of several paramaters can identify the current state of any eSIM profile. For example:\n\n| **eSIM Status** | `smdpStatus` | `esimStatus` | `orderUsage` | `eid` |\n| --- | --- | --- | --- | --- |\n| **New** | `RELEASED` | `GOT_RESOURCE` | `0` | `\"\"` |\n| **Onboard** | `ENABLED` | `IN_USE` `GOT_RESOURCE` | `0` | `\"890…222\"` |\n| **In Use** | `ENABLED` `DISABLED` | `IN_USE` | `123` | `\"890…222\"` |\n| **Depleted** | `ENABLED` `DISABLED` | `USED_UP` | `999` | `\"890…222\"` |\n| **Deleted** | `DELETED` | `USED_UP` `IN_USE` | `999` | `\"890…222\"` |\n\n##### Request Parameters\n\n``` json\n{\n    \"orderNo\":\"B23120118131854\",\n    \"iccid\":\"\",\n    \"pager\":{\n        \"pageNum\":1,\n        \"pageSize\":20\n    }\n}\n\n ```\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `orderNo` | String | optional | Order number | `B2210206381924` |\n| `iccid` | String | optional | eSIM ICCID | `89852246280001113119` |\n| `startTime` | String | optional | Starting time (ISO UTC time) | `2010-06-30T01:20+00:00` |\n| `endTime` | String | optional | End time (ISO UTC time) | `2010-06-30T02:20+00:00` |\n| `pager` | PageParam | required | Page parameters: `pageSize` `pageNum` |  |\n\n| Domain | Type | MOC | Description | Example |\n| --- | --- | --- | --- | --- |\n| `pageSize` | Integer | required | Page size, value range: \\[5, 500\\] | `10` |\n| `pageNum` | Integer | required | Page number, value range: \\[1, 10000\\] | `1` |\n\n##### Response Parameters\n\n``` json\n{\n  \"success\": true,\n  \"errorCode\": \"0\",\n  \"errorMsg\": null,\n  \"obj\": {\n    \"esimList\": [\n      {\n        \"esimTranNo\": \"23120118156818\",\n        \"orderNo\": \"B23120118131854\",\n        \"transactionId\": \"test344343433\",\n        \"imsi\": \"232104070077567\",\n        \"iccid\": \"8943108170000775671\",\n        \"smsStatus\": 1,\n        \"msisdn\": \"436789040077567\",\n        \"ac\": \"LPA:1$rsp-eu.roumiomobile.com$43DE23C67EE747BCAD6B63E8B67B261F\",\n        \"qrCodeUrl\": \"https://qr.roumio.com/?id=31068bd2-9d77-49f6-80d8-92692536f66b\",\n        \"shortUrl\": \"https://qr.roumio.com/?id=31068bd2-9d77-49f6-80d8-92692536f66b\",\n        \"smdpStatus\": \"RELEASED\",\n        \"eid\": \"\",\n        \"activeType\": 1,\n        \"dataType\": 1,\n        \"activateTime\": null,\n        \"expiredTime\": \"2024-05-29T18:34:17+0000\",\n        \"totalVolume\": 15000,\n        \"totalDuration\": 30,\n        \"durationUnit\": \"DAY\",\n        \"orderUsage\": 5000,\n        \"esimStatus\": \"CANCEL\",\n        \"pin\": \"\",\n        \"puk\": \"\",\n        \"apn\": \"drei.at\",\n        \"packageList\": [\n          {\n            \"packageName\": \"Spain 5GB 30Days\",\n            \"packageCode\": \"CKH003\",\n            \"slug\": \"ES_5_30\",\n            \"duration\": 30,\n            \"volume\": 5368709120,\n            \"locationCode\": \"ES\",\n            \"createTime\": \"2023-12-01T18:34:17+0000\"\n          }\n        ]\n      }\n    ],\n    \"pager\": {\n      \"pageSize\": 20,\n      \"pageNum\": 1,\n      \"total\": 1\n    }\n  }\n}\n\n ```\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `success` | String | required | `true`: succeeded `false`: failed | `true` |\n| `errorCode` | String | optional | `null` or `0` when successful. Error code when failed | `null` |\n| `errorMessage` | String | optional | Explanation of the error code | `null` |\n| `obj` | Object | optional | Includes: `esimList` `pager` |  |\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `pager` | PageParam | required | Includes: `pageSize` `pageNum` |  |\n| `esimList` | List | required | List of eSIM Profiles, including: `esimTranNo` `orderNo` `imsi` `iccid` `ac` `qrCodeUrl` `smdpStatus` `eid` `activeType` `expiredTime` `totalVolume` `totalDuration` `durationUnit` `orderUsage` `esimStatus` `packageList` |  |\n\n| PageParam | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `pageSize` | Integer | required | Page size, range: \\[5, 500\\] | `10` |\n| `pageNum` | Integer | required | Page number, value range: \\[1, 10000\\] | `1` |\n| `total` | Long | required | Total number of Profiles | `120` |\n\n| eSIM | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `esimTranNo` | String | required | eSIM transaction number | `22102706381912` |\n| `orderNo` | String | required | Order number | `B22102706381924` |\n| `imsi` | String | optional | IMSI | `454006109846571` |\n| `iccid` | String | optional | ICCID | `89852245280000942210` |\n| `msisdn` | String | optional | MSISDN | `xxxxx` |\n| `smsStatus` | Integer | required | `0` Does not support SMS `1` Can accept SMS sent by mobile phones and API `2` Only SMS sent by API is acceptable. | `0` |\n| `dataType` | Integer | required | `1` fixed amount  <br>`2` reset daily unlimited FUP | `1` |\n| `ac` | String | required | eSIM Activation Code  <br>LPA:1${SM-DP+_ADDRESS}${MATCHING_ID} | `LPA:1$rsp-eu.roumiomobile.com$451F9802E6854E3E85FB985235EDB4E5` |\n| `qrCodeUrl` | String | required | QR Code URL | [https://qr.roumio.com/?id=31068bd2-9d77-49f6-80d8-92692536f66b](https://qr.roumio.com/?id=31068bd2-9d77-49f6-80d8-92692536f66b) |\n| `smdpStatus` | String | required | SM-DP+ status: `RELEASED`: Profile is ready for download `DOWNLOAD`: Profile has been downloaded `INSTALLATION`: Profile has been installed `ENABLED`: Profile has been enabled `DISABLED`: Profile has been disabled `DELETED`: Profile has been deleted | `RELEASED` |\n| `eid` | String | optional | EID |  |\n| `activeType` | String | required | Activation type: `1`: First installation.  <br>`2`: First network connection. | `1` |\n| `expiredTime` | DateTime | required | Expiration time | `2023-03-03T06:20:00+0000` |\n| `totalVolume` | Long | required | Total data volume (in mega bytes) in the package | `15000` |\n| `totalDuration` | Integer | required | Total valid period of the package | `7` |\n| `durationUnit` | String | required | Time unit | `DAY` |\n| `orderUsage` | Long | required | Volume (in mega bytes) of used data | `5000` |\n| `pin` `puk` `apn` | String | optional | PIN, PUK APN values if any | `329393` |\n| `esimStatus` | String | required | `CREATE` an order has been created `PAYING` the subscriber is making payment for the eSIM `PAID` the eSIM has been paid `GETTING_RESOURCE` the eSIM is being allocated for the order `GOT_RESOURCE` the eSIM has been allocated for the order `IN_USE` the eSIM data package is in use `USED_UP` the data in the package is used up `UNUSED_EXPIRED` The valid period for eSIM download has expired `USED_EXPIRED` the valid period for the order activation has expired `CANCEL` the order has been canceled `SUSPENDED` the order has been suspended via suspend endpoint. `REVOKE` the order has been revoked via revoke endpoint. | `UNUSED_EXPIRED` |\n| `packageList` | List | required | Includes: `packageCode` `duration` `volume` `locationCode` |  |\n\n| eSIM | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `packageCode` | String | required | Package ID | `CKH179` |\n| `duration` | Integer | required | Valid period of the order | `7` |\n| `volume` | Long | required | Data volume (in mega bytes) in the order | `4096` |\n| `locationCode` | String | required | Country code of plan | `AZ` |\n\n### Balance Query\n\n#### URL\n\n```\nhttps://platform.roumio.com/v1/balance\n\n ```\n\nQuery the `balance` of a merchant account. Balance is used when ordering data profiles.\n\n##### Request Parameters\n\nNone.\n\n##### Reponse Parameters\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `success` | String | required | `true`: succeeded `false`: failed | `true` |\n| `errorCode` | String | optional | `null` or `0` when successful. Error code when failed. | `null` |\n| `errorMessage` | String | optional | Explanation of the error code | `null` |\n| `obj` | Object | optional | Includes: `balance` |  |\n\n| Domain | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `balance` | Long | required | Merchant balance | `1000` |\n\n### Top Up\n\n#### URL\n\n```\nhttps://platform.roumio.com/v1/esim/topup\n\n ```\n\nAfter a query of available top up plans for an\n\n`iccid` , `esimTranNo`or `packageCode`, the top up endpoint allows an existing installed eSIM to be loaded with a new plan. To top up the plan, you need its ICCID or esimTranNo and the **compatible** top up data plan `packageCode`.\n\n##### Request Parameters\n\n| Name | Type | Is Required | Description | Example |\n| --- | --- | --- | --- | --- |\n| `iccid` | String | optional | eSIM ICCID (depreciated, use `esimTranNo` ) | `89852246280001113119` |\n| `esimTranNo` | String | optional | get from \"Query All Allocated Profiles\"  <br>  <br>use \"iccid\" or \"esimTranNo\", can't be blank at the same time  <br>  <br>recommended. | `24111319542101` |\n| `packageCode` | String | required | Recharge Package Number | `SM001` |\n| `amount` | String | optional | Price of package, if used will be verified. | `10000` |\n| `transactionId` | String | required | User created transaction ID | `TXN-123` |\n\n**Respone Parameters**\n\n| obj | Type | MOC | Description | Example |\n| --- | --- | --- | --- | --- |\n| `transactionId` | String | required | Transaction ID returned | `TXN-123` |\n| `iccid` | String | required | ICCID of the eSIM | `89852245280001354019` |\n| `expiredTime` | Long | required | New date of pakcage expiry | `2023-08-17T17:01:37+0000` |\n| `totalVolume` | Long | required | New voulme of data | `12000` |\n| `totalDuration` | Integer | required | New duration in days | `28` |\n| `orderUsage` | Long | required | Total data usage | `207239584` |\n\n### Set Webhook\n\nWe send 4 webhook notifications types. Set your webhook URL from your Account.\n\nThe noifications currently sent are:\n\n- esim is created\n    \n- esim is installed\n    \n- esim has 50%, 20% and 10% remaining\n    \n- esim has 1 day of validity remaining\n    \n- esim is deleted or canceled\n    \n\nThe types are:\n\n- ORDER_STATUS - Ordered eSIM(s) are ready for download\n    \n- ESIM_STATUS - eSIM is in use\n    \n- DATA_USAGE - eSIM data is 50%, 20% or 10% remaining\n    \n- VALIDITY_USAGE - eSIM validity is 1 day\n    \n\n``` json\n{\n    \"notifyType\": \"ORDER_STATUS\",\n    \"content\": {\n        \"orderNo\": \"B23072016497499\",\n        \"orderStatus\": \"GOT_RESOURCE\"\n    }\n}\n\n ```\n\n``` json\n{\n    \"notifyType\": \"ESIM_STATUS\",\n    \"content\": {\n        \"orderNo\": \"B23072016497499\",\n        \"transactionId\": \"Your_txn_id\",\n        \"iccid\": \"894310817000000003\",\n        \"esimStatus\": \"IN_USE\",\n        \"smdpStatus\": \"INSTALLATION\"\n    }\n}\n\n ```\n\n``` json\n{\n    \"notifyType\": \"DATA_USAGE\",\n    \"content\": {\n        \"orderNo\": \"B23072016497499\",\n        \"transactionId\": \"Your_txn_id\",\n        \"iccid\": \"894310817000000003\",\n        \"totalVolume\": 1000,\n        \"orderUsage\": 900,\n        \"remain\": 1\n    }\n}\n\n ```\n\n``` json\n{\n    \"notifyType\": \"VALIDITY_USAGE\",\n    \"content\": {\n        \"orderNo\": \"B23072016497499\",\n        \"transactionId\": \"Your_txn_id\",\n        \"iccid\": \"894310817000000003\",\n        \"durationUnit\": \"DAY\",\n        \"totalDuration\": 30,\n        \"expiredTime\": \"2024-01-11T08:10:19Z\",\n        \"remain\": 1\n    }\n}\n\n ```\n\n``` json\n{\n  \"notifyType\": \"ESIM_STATUS\",\n  \"content\": {\n    \"orderNo\": \"B24112011030010\",\n    \"esimTranNo\": \"24112011030010\",\n    \"transactionId\": \"56352736-1-1\",\n    \"iccid\": \"898500000048984\",\n    \"esimStatus\": \"CANCEL\",\n    \"smdpStatus\": \"RELEASED\"\n  }\n}\n\n ```\n\n# Contact & Support\n\n- **Email**: [help@roumio.com](https://mailto:help@roumio.com)\n    \n- **Phone**: +994 10 214 03 25\n    \n- **Live Chat**: Available on the bottom-right corner of our website.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13277461","team":2833263,"collectionId":"35357fad-03ef-4511-8ec5-8e3e915db3e5","publishedId":"2sAYk8thEX","public":true,"publicUrl":"https://docs.roumio.com","privateUrl":"https://go.postman.co/documentation/13277461-35357fad-03ef-4511-8ec5-8e3e915db3e5","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Comprehensive reference for all Roumio API endpoints, including instructions for user management, placing orders for data packages, handling daily plans, and verifying costs. This documentation provides clear examples, best practices, and troubleshooting tips to help you integrate Roumio services seamlessly into your a"},{"name":"title","value":"Roumio API Documentation"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/f5a00bd6-e616-4a3e-8d0b-d47f9ea243e7/bG9nby13aGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":"https://content.pstmn.io/f5a00bd6-e616-4a3e-8d0b-d47f9ea243e7/bG9nby13aGl0ZS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2025-03-11T16:23:34.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Roumio API Documentation","description":"Comprehensive reference for all Roumio API endpoints, including instructions for user management, placing orders for data packages, handling daily plans, and verifying costs. This documentation provides clear examples, best practices, and troubleshooting tips to help you integrate Roumio services seamlessly into your a"},"logos":{"logoLight":"https://content.pstmn.io/f5a00bd6-e616-4a3e-8d0b-d47f9ea243e7/bG9nby13aGl0ZS5wbmc=","logoDark":"https://content.pstmn.io/f5a00bd6-e616-4a3e-8d0b-d47f9ea243e7/bG9nby13aGl0ZS5wbmc="}},"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/bbf884aee3733fd89c231a15657926c50d31e7797bf5888f02a5182ce566b0be","favicon":"https://roumio.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://docs.roumio.com/view/metadata/2sAYk8thEX"}