Checking Usage

MobiMatter currently provides two ways of checking data usage for existing orders.

Unstructured Endpoint

Click for relevant API endpoint

This endpoint will return the usage report for the order in an unstructured string manner.

Structured Endpoint

Click for relevant API endpoint

Returns detailed eSIM info in a structured JSON format.

Provider feature compatibility

Provider	Data Usage	eSIM Installation Status	Last Known Location
eSIMGo	✅	✅	✅
Sparks	✅	✅	✅
3HK	✅	✅	🛑
Flexiroam	✅	🛑	✅
Ubigi	✅	✅	✅
TSIM	✅	✅	🛑
IIJ	✅	✅	🛑
Annatel	✅	🛑	🛑
Airalo	✅	🛑	🛑
Others	🛑	🛑	🛑

Example response

{
    "ussdCode": null,
    "esim": {
        "status": "Installed",
        "installationDate": "2023-02-10T11:35:46Z",
        "location": {
            "updated": "2023-01-10T13:29:46Z",
            "country": "LK",
            "network": "Mobitel (Pvt) Limited"
        },
        "kycStatus": null,
        "iccid": "89312261000114250",
        "phoneNumber": null,
        "wallet": {
            "balanceHkd": 0
        }
    },
    "packages": [
        {
            "name": "Topup Europe Plus 5 GB",
            "associatedProductId": "686660c4-d475-4a6a-af4b-4579bcc8057e",
            "activationDate": "2023-02-10T11:36:38Z",
            "expirationDate": "2023-03-12T11:36:38Z",
            "totalAllowanceMb": 5000,
            "totalAllowanceMin": null,
            "usedMin": null,
            "usedMb": 59
        }
    ]
}

Key	Type	Description
ussdCode	string | null	USSD code for balance check, if exists.
esim.status	Installed | Available | null	eSIM scan status, null when eSIM status is unknown.
esim.installationDate	Date | null	Installation date
esim.location.updated	Date | null	Last update to location data
esim.location.country	string | null	ISO 2-letter country code
esim.location.network	string | null	-
esim.kycStatus	null | IN_PROGRESS | REJECTED | APPROVED	3HK KYC status
esim.iccid	string	-
esim.wallet.balanceHKD	number	3HK internal wallet balance (e.g for PAYG call allowance)
packages.*.name	string	-
packages.*.associatedProductId	string	This will always return the esim_realtime version of the product, even if it was purchased as a top up
packages.*.activationDate	Date | null	null before activation
packages.*.expirationDate	Date | null	null before activation
packages.*.totalAllowanceMb	number | null	Total data in this package in MB
packages.*.totalAllowanceMin	number | null	Total minutes allowance in this package
packages.*.usedMb	number | null	Used data in this package in MB
packages.*.usedMin	number | null	Used minutes allowance in this package