# MIOeSIM

## Docs

- [POST /api_esim/refundOrder — Cancel a SIM order](https://developers.mioesim.com/api-reference/cancel-order.md): Cancel or unsubscribe a SIM card order by order number and ICCID. Supports eSIM and physical SIM. Partial cancellations are supported by specifying ICCIDs.
- [GET /api_esim/getBalance — Get account balance](https://developers.mioesim.com/api-reference/get-balance.md): Retrieve your current MIOeSIM account balance and currency. Orders are automatically deducted from this pre-funded balance when placed via the API.
- [GET /api_esim/getPhysicalSIMDpInfo — List DP providers](https://developers.mioesim.com/api-reference/get-dp-info.md): Retrieve the list of physical SIM distribution partners (DPs) available on your account. The returned dpId is required when placing physical SIM card orders.
- [GET /api_esim/getDpSupportPackageInfo — DP packages](https://developers.mioesim.com/api-reference/get-dp-packages.md): Get available data plans for a physical SIM distribution partner. Returns price, data amount, validity, priceid, and apiCode needed for ordering.
- [GET /api_esim/getDpSupportSkuInfo — List SKUs for a DP](https://developers.mioesim.com/api-reference/get-dp-skus.md): Retrieve the list of product SKUs supported by a physical SIM distribution partner (DP). Requires the dpId returned by the List DP Providers endpoint.
- [GET /api_esim/getDpSupportSkuInfoByGroup — DP SKUs](https://developers.mioesim.com/api-reference/get-dp-skus-by-continent.md): Retrieve physical SIM SKUs for a distribution partner, organized by continent. Returns a map keyed by continent name, matching the eSIM grouped SKU format.
- [GET /api_esim/reDownOrderPDF — Re-download eSIM card info](https://developers.mioesim.com/api-reference/get-esim-card-info.md): Retrieve eSIM card activation details or PDF URL for an existing order. Use backInfo to return just the order number, full card details, or PDF download links.
- [GET /api_esim/getESIMDetail — ICCID usage and card status](https://developers.mioesim.com/api-reference/get-iccid-detail.md): Retrieve usage, network support, plan history, and card status for a specific ICCID. This endpoint requires IP whitelist approval from MIOeSIM before use.
- [GET /api_esim/getHistoryDetail — ICCID historical packages](https://developers.mioesim.com/api-reference/get-iccid-history.md): Retrieve the full package history for a SIM card by ICCID, including past plan orders, usage data, and start and end dates for each plan.
- [GET /api_esim/getIccidSupportPackageInfo — ICCID packages](https://developers.mioesim.com/api-reference/get-iccid-packages.md): Get available data plans for a SIM card identified by ICCID. Returns package details including priceid and apiCode, scoped to plans the card can activate.
- [GET /api_esim/getIccidSupportSkuGroup — SKUs by continent](https://developers.mioesim.com/api-reference/get-iccid-sku-groups.md): Retrieve SKUs available for renewal on a specific SIM card, organized by continent. Useful for building region-based renewal selection UIs for customers.
- [GET /api_esim/getIccidSupportSku — SKUs for an ICCID](https://developers.mioesim.com/api-reference/get-iccid-skus.md): Retrieve the products (SKUs) available for renewal on a SIM card by ICCID. Use skuid values with getIccidSupportPackageInfo to fetch purchasable plans.
- [GET /api_esim/getOrderInfo — Get order details by number](https://developers.mioesim.com/api-reference/get-order.md): Retrieve full details of a SIM card order by order number. Returns activation codes, ICCID, SM-DP+ address, and plan status for each card in the order.
- [GET /api_esim/getPackages — List data plans for a SKU](https://developers.mioesim.com/api-reference/get-packages.md): Fetch available data plans for an eSIM SKU. Returns flows, validity, price, priceid, apiCode, and network support — everything needed to place an order.
- [GET /api_esim/getSkus — List all eSIM SKUs](https://developers.mioesim.com/api-reference/get-skus.md): Retrieve the full catalog of available eSIM products (SKUs). Each SKU represents a country or regional coverage area you can order plans for.
- [GET /api_esim/getSkuByGroup — SKUs grouped by continent](https://developers.mioesim.com/api-reference/get-skus-by-continent.md): Retrieve all eSIM SKUs organized by continent. Useful for building region-based browsing UIs. Returns continents list and a map of SKU arrays.
- [POST /api_order/login — Authenticate and get a token](https://developers.mioesim.com/api-reference/login.md): Exchange your MIOeSIM phone number and password for a session token. Include this token in every subsequent API request alongside a valid request signature.
- [POST /api_esim/addEsimOrder — Place a SIM card order](https://developers.mioesim.com/api-reference/place-order.md): Place an eSIM or physical SIM card order using a SKU ID and price ID. Returns activation codes, QR code data, and ICCID for each card ordered.
- [POST /api_esim/addEsimOrderByApiCode — Order by API code](https://developers.mioesim.com/api-reference/place-order-by-apicode.md): Place an eSIM or physical SIM order using a package's apiCode instead of skuId and priceId. Ideal when you have pre-negotiated specific package codes.
- [GET /api_esim/queryEsimOrder — Query SIM card order list](https://developers.mioesim.com/api-reference/query-esim-orders.md): List eSIM and physical SIM card orders with rich filtering: by order number, ICCID, status, date range, card type, and external IDs. Paginated.
- [GET /api_esim/queryIccidInformation — Batch query cards](https://developers.mioesim.com/api-reference/query-iccid-info.md): Query card status, expiry date, renewal eligibility, and card type for up to 100 ICCIDs in a single request. Returns a result object per ICCID.
- [GET /api_esim/queryOrder — Query eSIM order list (legacy)](https://developers.mioesim.com/api-reference/query-orders.md): List eSIM orders within a date range. This is the legacy order query endpoint — use Query eSIM Orders for more filter options and physical SIM support.
- [POST /api_esim/renewCard — Renew a SIM card plan](https://developers.mioesim.com/api-reference/renew-order.md): Renew a SIM card plan by order number or ICCID. Supports eSIM and physical SIM card renewal. Returns a new order with renewal card details.
- [POST /api_esim/renewCardByApiCode — Renew plan by API code](https://developers.mioesim.com/api-reference/renew-order-by-apicode.md): Renew a SIM card plan using a package's apiCode instead of skuId and priceId. Identify the card by order number or ICCID. Supports eSIM and physical SIM.
- [POST /api_esim/handlerEsimPdf — Send PDF or get link](https://developers.mioesim.com/api-reference/send-pdf-email.md): Send an eSIM activation PDF to a customer email address, or retrieve a direct download URL. Supports targeting one or more specific ICCIDs within an order.
- [GET /api_esim/verifyResource — Check card inventory](https://developers.mioesim.com/api-reference/verify-resources.md): Check whether sufficient card inventory exists for a given SKU and price ID. Returns 1 if resources are available, 0 if not. Call this before large bulk orders.
- [GET /api_esim/verifyResourceByApiCode — Check inventory](https://developers.mioesim.com/api-reference/verify-resources-by-apicode.md): Check whether sufficient card inventory exists for a package by its apiCode. Returns 1 if resources are available, 0 if insufficient. Use before bulk orders.
- [Authenticate with the MIOeSIM API](https://developers.mioesim.com/authentication.md): Learn how the MIOeSIM two-part auth system works: obtain a session token via login, then sign every request with an HMAC-MD5 signature.
- [ICCID and card management](https://developers.mioesim.com/concepts/iccid-and-cards.md): Learn what the ICCID is, how eSIM and physical SIM cards differ, and how to query card status, usage, and renewal eligibility using ICCID-based endpoints.
- [Orders: the MIOeSIM order lifecycle](https://developers.mioesim.com/concepts/orders.md): Learn how MIOeSIM orders are structured, what each status code means, how renewal and cancellation work, and how to map orders to your platform's IDs.
- [SKUs and packages: the MIOeSIM catalog](https://developers.mioesim.com/concepts/skus-and-packages.md): Understand how SKUs (coverage areas) and packages (data plans) are structured in the MIOeSIM catalog, and which fields matter when building and placing orders.
- [Java integration guide for the MIOeSIM API](https://developers.mioesim.com/examples/java.md): Authenticate with MIOeSIM, compute HMAC-MD5 request signatures, and make API calls from Java using Apache Commons Codec and the Jodd HTTP client.
- [PHP integration guide for the MIOeSIM API](https://developers.mioesim.com/examples/php.md): Authenticate with MIOeSIM and make signed API calls from PHP using built-in hash functions and cURL. Full working examples with no external dependencies.
- [Python integration guide for the MIOeSIM API](https://developers.mioesim.com/examples/python.md): Authenticate with MIOeSIM, compute HMAC-MD5 request signatures, and manage token refresh from Python using the requests library and built-in hashlib module.
- [MIOeSIM API: Global eSIM & SIM connectivity platform](https://developers.mioesim.com/introduction.md): The MIOeSIM API gives resellers and platforms programmatic access to a global catalog of eSIM and physical SIM card plans across 125+ countries.
- [Get started with the MIOeSIM API](https://developers.mioesim.com/quickstart.md): Make your first MIOeSIM API call in minutes: authenticate, browse eSIM products, and place a working order that returns real activation codes and ICCIDs.
- [MIOeSIM API error codes and troubleshooting](https://developers.mioesim.com/reference/error-codes.md): Reference for the code field in every MIOeSIM API response — what each value means, how to resolve common errors, and how to debug signature and token issues.
- [Order status codes in MIOeSIM](https://developers.mioesim.com/reference/order-statuses.md): Reference for the integer status codes returned in the status field of MIOeSIM order responses — what each code means and how orders move between states.
- [Supported PDF languages for eSIM delivery](https://developers.mioesim.com/reference/pdf-languages.md): Language codes for the pdfLanguage parameter — controls which language the eSIM activation PDF is generated in when you place or renew an order.

## OpenAPI Specs

- [openapi](https://developers.mioesim.com/api-reference/openapi.json)