ITT E-Sim API (1.0.0)

Download OpenAPI specification:

E-Sim API endpoints converted from Postman collection.

E-Sim

E-Sim search, pricing, booking, ancillaries and post-booking flows.

eSIM Search & Inquiry

Search eSIM plans

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
required
object
supplier_uid
string

Supplier identifier (use 'all' for all suppliers)

partner_id
string

Partner account ID

short_ref
string

Optional short reference ID for stream search

language
string

Response language

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "eSim": {
    },
  • "supplier_uid": "all",
  • "partner_id": "1",
  • "short_ref": "xxxx111",
  • "language": "en"
}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "reason": "A total of 24 eSIM packages were found for your search.",
  • "tracking_id": "117726070533RO1",
  • "search_parameter": {
    },
  • "total_esim_package": "24,",
  • "data": {
    },
  • "supplier": {
    },
  • "filter": {
    },
  • "-"filter"": {
    }
}

Get single eSIM package

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
tracking_id
required
string

Search tracking ID returned from eSIM plan search

package_id
required
string

Unique eSIM package identifier

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "tracking_id": "11763299361URM1",
  • "package_id": "X1AO00012||bangladesh||1067||fatafati-in-7days-1gb"
}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "tracking_id": "11177260822126194QDWJV",
  • "search_parameter": {
    },
  • "data": {
    },
  • "region_details": {
    },
  • "operator_details": {},
  • "coverage_country": [
    ],
  • "price": {
    },
  • "fmg": {
    },
  • "supplier": {
    },
  • "fair_usage_policy": "null,",
  • "qr_installation": "<p><br></p><p><b>eSIM name:</b> Fatafati</p><p><br></p><p><b>Coverage:</b>Bangladesh</p><p><br></p><p><b>To activate the eSIM by scanning the QR code on your eSIM capable device you need to print or display this QR code on other device:</b></p><p><br></p><ol><li>Settings > Cellular/Mobile > Add Cellular/Mobile Plan.</li><li>Scan QR code.</li><li>Confirm eSIM plan details.</li><li>Label the eSIM.</li></ol><p><br></p><p><b>To access Data:</b></p><p><br></p><ol><li>Enable data roaming.</li></ol><p><br></p><p><b>To top up:</b></p><p><br></p><p>Visit airalo.com/my-esims or if purchased through the Airalo website/app visit “My eSIMs” tab.</p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p>",
  • "manual_installation": "<p><br></p><p><b>eSIM name:</b> Fatafati</p><p><br></p><p><b>Coverage: </b>Bangladesh</p><p><br></p><p><b>To manually activate the eSIM on your eSIM capable device:</b></p><p><br></p><ol><li>Settings > Cellular/Mobile > Add Cellular/Mobile Plan.</li><li>Manually enter the SM-DP+ Address and activation code.</li><li>Confirm eSIM plan details.</li><li>Label the eSIM.</li></ol><p><br></p><p><b>To access Data:</b></p><p><br></p><ol><li>Enable data roaming.</li></ol><p><br></p><p><b>To top up:</b></p><p><br></p><p>Visit airalo.com/my-esims or if purchased through the Airalo website/app visit “My eSIMs” tab.</p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p><p><br></p>"
}

Get compatible devices

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
member_id
required
integer

Logged-in user member ID

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "member_id": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "reason": "Compatible devices data found.",
  • "compatible_devices": {
    }
}

eSIM Booking

Update customer information

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
booking_tracking_id
required
string

Booking tracking ID received from validation step

member_id
required
string

Logged-in user member ID

save_pax
string

Save passenger data for future bookings (yes / no)

required
Array of objects

Passenger details

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "booking_tracking_id": "11176335754526194RQYGH",
  • "member_id": "2",
  • "save_pax": "yes",
  • "passenger": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "reason": "Customer data has been successfully updated.",
  • "tracking_id": "11177260822126194QDWJV",
  • "total_guest": 1,
  • "data": [
    ]
}

Create eSIM booking

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
booking_tracking_id
required
string

Booking tracking ID from validation step

package_tracking_id
required
string

Unique package tracking identifier

eSim_quantity
required
string

Number of eSIM packages to purchase

member_id
required
string

Logged-in user member ID

isPartialPay
string

Whether partial payment is allowed (yes / no)

redirect_url
string <uri>

Redirect URL after payment completion

payment_type
required
string

Payment method (account_balance / card / onlinepayment)

isd_code
string

ISD code for contact number

contact_no
string

Contact number of the customer

email_address
string <email>

Customer email address

agency_email
string <email>

Agency email address

property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "reason": "The booking has been successfully created, and it is associated with the Booking Id ES2604MAYVA3A8.",
  • "tracking_id": "11177260822126194QDWJV",
  • "booking_id": "ES2604MAYVA3A8",
  • "general": {
    },
  • "eSim": {},
  • "booking": {
    },
  • "price": {
    },
  • "eSim_package": {
    },
  • "supplier_uid": "X1AO00084",
  • "partner_id": "1",
  • "short_ref": "xxxx111",
  • "language": "en",
  • "-"tracking_id"": "117726070533RO1",
  • "supplier_type": "ESIM",
  • "supplier_code": "airalo",
  • "supplier_partner_code": "airalo-1-00084",
  • "data": {
    }
}

Get installation instructions

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
member_id
required
string

Logged-in user member ID

tracking_id
required
string

eSIM or booking tracking ID

eSim_iccid
required
string

ICCID of the eSIM

preferred_language
string

Preferred response language.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "member_id": "1",
  • "tracking_id": "11176276126126194RHSGI",
  • "eSim_iccid": "873000000000040589",
  • "preferred_language": "en"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "tracking_id": "11177260822126194QDWJV",
  • "booking_id": "ES2604MAYVA3A8",
  • "eSim_iccid": "8900000281278633887",
  • "instructions": {
    },
  • "version": "15.0,14.0,13.0,12.0",
  • "model": "null,",
  • "installation": {
    }
}

eSIM Management

Get data usage

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
member_id
required
string

Logged-in user member ID

tracking_id
required
string

Booking or eSIM tracking ID

eSim_iccid
required
string

eSIM ICCID (Integrated Circuit Card Identifier)

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "member_id": "2",
  • "tracking_id": "11176276126126194RHSGI",
  • "eSim_iccid": "873000000000040589"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "tracking_id": "11177260822126194QDWJV",
  • "booking_id": "ES2604MAYVA3A8",
  • "eSim_iccid": "8900000281278633887",
  • "instructions": {
    }
}

Get booking details

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
member_id
required
string

Logged-in user member ID

tracking_id
required
string

eSIM or booking tracking ID

booking_id
required
string

Booking ID for the eSIM package

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "member_id": "2",
  • "tracking_id": "11176276126126194RHSGI",
  • "booking_id": "ES2510NOKJAAFK"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "reason": "Booking Details For Tracking Id 119177311942703210WDEPJ",
  • "tracking_id": "119177311942703210WDEPJ",
  • "booking_id": "FL2610MAPSA3D7",
  • "pay_tracking_id": null,
  • "sendGTMEvent": false,
  • "general": {
    },
  • "changeLogs": [ ],
  • "voucher": {},
  • "action": {
    },
  • "voidRefundData": [ ],
  • "reIssueData": [ ],
  • "booking": {
    },
  • "price": {
    },
  • "bookingPaymentRequestDtata": [ ],
  • "syncData": {
    },
  • "flight": {
    },
  • "additional_baggage": [ ],
  • "additional_meal": [ ],
  • "pax_seat_plan": [ ],
  • "baggage_protection": [ ],
  • "additional_services": [ ],
  • "discount_data": [ ],
  • "pax": {
    },
  • "invoice_data": [ ],
  • "refund_status_list": [
    ],
  • "refund_data": [ ],
  • "partner": {},
  • "supplier": {
    },
  • "terms": {
    },
  • "cancellation_terms": {
    },
  • "special_notice_status": "disable",
  • "special_notice": null
}

Top-up Services

Get top-up packages

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
member_id
required
string

Logged-in user member ID

tracking_id
required
string

Booking or eSIM tracking ID

eSim_iccid
required
string

eSIM ICCID (Integrated Circuit Card Identifier)

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "member_id": "1",
  • "tracking_id": "11176328969726194MHHQA",
  • "eSim_iccid": "873000000000042014"
}

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "reason": "A total of 12 topup packages were found for your eSim.",
  • "topup_tracking_id": "TUP117726938847PY1",
  • "request_data": {
    },
  • "total_esim_package": "12,",
  • "data": {
    },
  • "price": {
    },
  • "sell": null,
  • "total": {
    },
  • "price_breakdown": {
    }
}

Create top-up booking

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
booking_tracking_id
required
string

Booking tracking ID from validation

topup_tracking_id
required
string

Top-up tracking ID

package_id
required
string

Package identifier including ICCID and plan

member_id
required
string

Logged-in user member ID

redirect_url
required
string

URL to redirect after payment

payment_type
required
string

Payment type (account_balance / card / onlinepayment)

isd_code
required
string

Country ISD code

contact_no
required
string

Contact number

email_address
required
string

Customer email address

agency_email
string

Agency email address (optional)

property name*
additional property
any

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "Status": "Success"
}

Get top-up history

Authorizations:
(apiKeyAuthsecretCodeAuth)
Request Body schema: application/json
required
member_id
required
string

Logged-in user member ID

tracking_id
required
string

Booking or eSIM tracking ID

eSim_iccid
required
string

eSIM ICCID (Integrated Circuit Card Identifier)

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "member_id": "1",
  • "tracking_id": "11176328969726194MHHQA",
  • "eSim_iccid": "873000000000042014"
}

Response samples

Content type
application/json
{
  • "status": "Success"
}
Back to Portal