My eSIMs

List my eSIMs

POST

https://api.gmjroaming.com/api/v2

/myesim

List my eSIMs › Request Body

iccid

string

transaction_id

string

esim_status

string

per_page

integer · min: 1 · max: 100

page

integer · min: 1

List my eSIMs › Responses

200

eSIMs

Esim[]

object

POST/myesim

curl https://api.gmjroaming.com/api/v2/myesim \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "iccid": "iccid",
  "transaction_id": "transaction_id",
  "esim_status": "esim_status",
  "per_page": 1,
  "page": 1
}'

Example Request Body

{
  "iccid": "iccid",
  "transaction_id": "transaction_id",
  "esim_status": "esim_status",
  "per_page": 1,
  "page": 1
}

json

Example Responses

{
  "data": [
    {
      "esimId": "esimId",
      "transactionId": "transactionId",
      "iccid": "iccid",
      "installation": {
        "ac": "ac",
        "publicUrl": "publicUrl",
        "qrCodeUrl": "qrCodeUrl",
        "apn": "apn"
      },
      "status": "status",
      "actions": {
        "key": true
      },
      "activatedAt": "activatedAt",
      "expiresAt": "expiresAt",
      "durationDays": 0,
      "usage": {
        "type": "daily",
        "usedBytes": 0,
        "totalBytes": 0,
        "resetsAt": null
      },
      "packages": [
        {
          "packageCode": "packageCode",
          "packageName": "packageName",
          "duration": 0,
          "volume": 0,
          "locationCode": "locationCode"
        }
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "perPage": 0,
    "lastPage": 0
  }
}

json

application/json

Get install link and QR code

GET

https://api.gmjroaming.com/api/v2

/public-esim-link

Get install link and QR code › query Parameters

esimId

integer · required

Get install link and QR code › Responses

Links

object

Get data usage

POST

https://api.gmjroaming.com/api/v2

/esim-usage

For daily plans, totalVolume and remainBytes are null. See dailyUsage.

Get data usage › Request Body

esimId

integer · min: 1 · required

From /myesim.

Get data usage › Responses

200

Usage

object

Get installation events

POST

https://api.gmjroaming.com/api/v2

/esim-progress

Get installation events › Request Body

esimId

integer · min: 1 · required

From /myesim.

Get installation events › Responses

200

Events

object[]

Get device info

POST

https://api.gmjroaming.com/api/v2

/esim-device-info

Get device info › Request Body

esimId

integer · min: 1 · required

From /myesim.

Get device info › Responses

200

Device

object

Suspend an eSIM

POST

https://api.gmjroaming.com/api/v2

/suspend

Suspend an eSIM › Request Body

esimId

integer · min: 1 · required

From /myesim.

Suspend an eSIM › Responses

Accepted

object

Resume a suspended eSIM

POST

https://api.gmjroaming.com/api/v2

/unsuspend

Resume a suspended eSIM › Request Body

esimId

integer · min: 1 · required

From /myesim.

Resume a suspended eSIM › Responses

200

Accepted

object

Cancel an unused eSIM (refund)

POST

https://api.gmjroaming.com/api/v2

/cancel-esim

Cancel an unused eSIM (refund) › Request Body

esimId

integer · required

packageCode

string · required

Cancel an unused eSIM (refund) › Responses

200

Accepted

object

Revoke an eSIM

POST

https://api.gmjroaming.com/api/v2

/revoke

Permanently disables the eSIM with no refund.

Revoke an eSIM › Request Body

esimId

integer · min: 1 · required

From /myesim.

Revoke an eSIM › Responses

200

Accepted

object

Purchase Transactions