website·Indexed 34 days ago
https://partner-api-airalo.apidog.ioDeveloper resources for integrating Airalo's eSIM connectivity services. Includes documentation for the REST API and SDK, covering package browsing, order placement, eSIM installation, usage monitoring, and top-ups. Features guides on webhooks, sandbox testing, rate limits, and a dedicated plugin for WooCommerce.
Airalo uses webhooks to push real-time data updates to a designated endpoint URL. When performing an opt-in, the system verifies the webhook_url via a HEAD request; the endpoint must respond with 200 OK for the opt-in to be successful.
Airalo supports three types of webhooks:
The White Label solution consists of two primary services:
The Get Packages endpoint returns detailed information about eSIM packages, including pricing across multiple currencies, installation methods, and coverage details.
Key data fields include:
price, net_price, and a prices object containing specific values for currencies such as USD, EUR, GBP, AUD, BRL, CAD, AED, INR, IDR, ILS, JPY, MYR, MXN, SGD, KRW, VND, and ZAR.id, type, amount (data volume), day (validity period), title, and short_info.qr_installation and manual_installation strings provide the necessary details for the user to activate the eSIM.is_unlimited (boolean) and is_fair_usage_policy (boolean) indicate the data limits and usage terms.apn_type, apn_value, esim_type, and is_roaming.coverages array contains objects with the country name, code, and associated networks.qr_installation and manual_installation (HTML formatted instructions), net_price (base cost), and a prices object containing net_price and recommended_retail_price mapped by currency codes (e.g., USD, EUR, GBP).- id: change-plus-7days-3gb-topup
type: topup
price: 12
amount: 3072
day: 7
is_unlimited: false
title: 3 GB - 30 SMS - 30 Mins - 7 days
net_price: 4.6
prices:
net_price:
USD: 4.6
EUR: 3.96
GBP: 3.45
recommended_retail_price:
USD: 12
EUR: 10.32
GBP: 9
qr_installation: "<p>...HTML instructions...</p>"
manual_installation: "<p>...HTML instructions...</p>"qr_installation and manual_installation (HTML formatted instructions), net_price (base cost), and a prices object containing net_price and recommended_retail_price mapped by currency codes (e.g., USD, EUR, GBP).{
"id": "mamma-mia-in-30days-10gb-topup",
"type": "topup",
"price": 20.5,
"amount": 10240,
"day": 30,
"is_unlimited": false,
"title": "10 GB - 30 days",
"net_price": 5.1,
"prices": {
"net_price": {
"USD": 5.1,
"EUR": 4.39,
"GBP": 3.82
},
"recommended_retail_price": {
"USD": 20.5,
"EUR": 17.63,
"GBP": 15.38
}
},
"qr_installation": "<p>...</p>",
"manual_installation": "<p>...</p>"
}Using the Airalo SDKs for B2B Partner API integration provides several technical advantages:
plan_type (e.g., data-voice-text), activation_policy, install_window_days, and apn settings for both iOS and Android. Each package object contains specific details such as id, type (e.g., 'sim' or 'topup'), amount (data in MB), day (validity period), and HTML-formatted installation instructions (qr_installation and manual_installation).plan_type: data-voice-text
activation_policy: first-usage
is_kyc_verify: false
rechargeability: true
coverages:
- name: US
code: US
networks:
- name: T-Mobile
types: ["5G"]
packages:
- id: change-plus-3days-1gb
type: sim
price: 6
amount: 1024
day: 3
data: 1 GB
voice: 10
text: 10
prices:
net_price:
USD: 2.8
EUR: 2.41
recommended_retail_price:
USD: 6
EUR: 5.16GET /v2/sims endpoint returns a paginated list of eSIMs. Each eSIM record contains critical installation data, including the ICCID, LPA, and QR code information, as well as details about the associated order and package.// Example Response Structure
{
"data": [
{
"id": 11047,
"created_at": "2023-02-27 14:09:55",
"iccid": "891000000000009125",
"lpa": "lpa.airalo.com",
"imsis": null,
"matching_id": "TEST",
"qrcode": "LPA:1$lpa.airalo.com$TEST",
"qrcode_url": "https://sandbox.airalo.com/qr?expires=...",
"direct_apple_installation_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=...",
"voucher_code": null,
"airalo_code": null,
"apn_type": "automatic",
"apn_value": null,
"is_roaming": true,
"confirmation_code": null,
"order": null,
"brand_settings_name": "our perfect brand",
"recycled": true,
"recycled_at": "2025-05-05 10:52:39",
"simable": {
"id": 9666,
"code": "20230227-009666",
"package_id": "kallur-digital-7days-1gb",
"package": "Kallur Digital-1 GB - 7 Days",
"esim_type": "Prepaid",
"validity": "7",
"price": "9.50",
"currency": "USD",
"data": "1 GB",
"manual_installation": "<p>HTML content for manual setup</p>"
}
}
],
"links": {
"first": "...",
"last": "...",
"prev": null,
"next": "..."
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 10,
"per_page": "15",
"to": 15,
"total": 150
}
}qr_installation and manual_installation (HTML formatted instructions), net_price and recommended_retail_price (mapped by currency code), and apn_value for manual network configuration.{
"id": "change-in-30days-3gb-topup",
"type": "topup",
"title": "3 GB - 30 days",
"data": "3 GB",
"net_price": 3,
"prices": {
"net_price": {
"USD": 3,
"EUR": 2.58,
"GBP": 2.25
},
"recommended_retail_price": {
"USD": 9,
"EUR": 7.74,
"GBP": 6.75
}
},
"qr_installation": "<p>HTML content for QR setup</p>",
"manual_installation": "<p>HTML content for manual setup</p>",
"apn_value": "wbdata"
}