Skip to main content

Issuing eSIM Replacement

This guide will show how to issue an eSIM replacement for providers that have a product of type esim_replacement.

1. Find the eSIM Replacement product id​

Use the Get Products API to search for an esim_replacement type product for the requested provider.

Example​

curl -L -X GET 'https://api.mobimatter.com/mobimatter/api/v2/products?provider=3&category=esim_replacement' \
-H 'Accept: text/plain' \
-H 'merchantId: <MerchantId>' \
-H 'api-key: <API_KEY_VALUE>'

2. Place a New Order​

Using the product id from the previous step, create a new order. Make sure to pass the old order id as the addOnOrderIdentifier

curl -L -X POST 'https://api.mobimatter.com/mobimatter/api/v2/order' \
-H 'Content-Type: application/json' \
-H 'api-key: <API_KEY_VALUE>' \
-H 'merchantId: <MerchantId>' \
--data-raw '{
  "productId": "9f0d2dcb-31d7-46d0-846d-bb68aa710e7e",
  "productCategory": "esim_replacement",
  "addOnOrderIdentifier": "XYZ-2322234"
}'

3. Complete the Order​

Complete the order with the Complete Order API. Note! eSIM replacement is an asynchronous process. The complete order will respond you with the order in Processing state

4. Poll order status​

Poll order status every few seconds with the Get Order API, you should expect the order to transition into the Completed state within a minute.

Once the order is Completed you can access the new LPA string and QR code.