Endpoints
Orders List
Top-up flow
Notification
Balance
Request access token
POST/v2/token
This endpoint provides an access token required for making authenticated requests to the Airalo Partners API. Submit your client ID and client secret ...
Get compatible device list
GET/v2/compatible-devices
This endpoint provides a comprehensive list of devices that are compatible with eSIMs. Use this information to ensure that your customers have devices...
Get packages
GET/v2/packages
Retrieve a list of local and global eSIM packages available through the Airalo Partners API. Local packages cover a single country, while global packa...
Submit order
POST/v2/orders
This endpoint allows you to submit an order to the Airalo Partners API. Provide the required information, such as quantity and package ID, and include...
Submit order async
POST/v2/orders-async
This endpoint allows you to submit an asynchronous order to the Airalo Partners API. This ensures greater performance and reduces the wait time for yo...
Submit top-up order
POST/v2/orders/topups
To submit a top-up order:
Make a POST request to the endpoint URL {{url}}/{{version}}/orders/topups
Include a request body in the form of a FormData o...
Get eSIM
GET/v2/sims/{sim_iccid}
This endpoint allows you to retrieve the details of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. You can include related d...
Get data usage
GET/v2/sims/{sim_iccid}/usage
Endpoint do support new type of packages - "Voice and Text"This endpoint comes with a Rate Limit: you can pull specific eSIM usage info once...
Get installation instructions
GET/v2/sims/{sim_iccid}/instructions
This endpoint allows you to retrieve the language specific installation instructions of a specific eSIM from the Airalo Partners API using the eSIM...
Update eSIM brand
PUT/v2/sims/{sim_iccid}/brand
This endpoint allows you to update assigned brand settings name of a specific eSIM from the Airalo Partners API using the eSIM's ICCID. This brand...
eSIM voucher
POST/v2/voucher/esim
This endpoint allows you to create an esim voucher to the Airalo Partners API. Provide the required information, such as quantity and package id
The a...
Refund Request
POST/v2/refund
Overview
The Airalo Refund API makes it simple to request refunds for eSIMs. This guide walks you through everything you need to know, including the A...
Future Orders
POST/v2/future-orders
This endpoint allows you to submit an order to the Airalo Partner API, which will be created on the specified due date.
To proceed, provide the requir...
Cancel future orders
POST/v2/cancel-future-orders
This endpoint allows you to submit future order cancellation requests via the Airalo Partner API.
To proceed, provide an array of request_id strings f...