Airalo Developer Platform
  1. Endpoints
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Partner with Airalo
    • Attribute descriptions
    • FAQ
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Guides
      • Step #1 - Authentication
    • Quick start
      • Request access token
      • Get packages
      • Submit order
      • Get installation instructions
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
        • Get top-up package list
        • Get eSIM package history
      • Notification
        • Understanding Webhooks: Asynchronous Communication for Modern Applications
        • Airalo Webhooks Optin and Flow
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Balance
        • Get balance
      • Request access token
        POST
      • Get compatible device list
        GET
      • Get packages
        GET
      • Submit order
        POST
      • Submit order async
        POST
      • Submit top-up order
        POST
      • Get eSIM
        GET
      • Get data usage
        GET
      • Get installation instructions
        GET
      • Update eSIM brand
        PUT
      • eSIM voucher
        POST
      • Refund Request
        POST
      • Future Orders
        POST
      • Cancel future orders
        POST
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
        • Get Order
        • Submit Order
        • Submit Top-up Order
      • eSIMs
        • Get eSIMs List
        • Get eSIM
        • Get Installation instructions
        • Get Data Usage
        • Get Top-up Package List
        • Get eSIM Package History
      • Order Statuses
        • Get Order Statuses List
        • Get Order Status Name
      • Packages
        • Get Packages
      • Compatible Devices
        • Get Compatible Device List
      • Notification
        • Low Data Notification
        • Credit Limit Notification
        • Webhook Definition
        • Webhook Simulator
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • TO DELETE Installation plugin backup
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY INTEGRATION
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Endpoints

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 access token, obtained from the "Request Access Token" endpoint, should be included in the request.
For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ
Body Structure:
{
    "vouchers": [
        {
            "package_id": "replace with actual package slug",
            "quantity": 3,
            "booking_reference": "123"
        }
    ]
}
Request parameters:
vouchers (array, required):
An array of voucher objects to be created for eSIMs. Each voucher object contains the following fields:
package_id (string, required):
The unique identifier (slug) of the eSIM package for which the voucher is being issued.
Example: "package_id": "eu-europe-5gb-30days"
quantity (integer, required):
The number of vouchers you wish to purchase for the specified package.
Example: "quantity": 3
booking_reference (string, optional):
An optional field used to store the booking reference for this voucher, which can be used for tracking purposes in your own system.
Example: "booking_reference": "123"
If not provided, this field will be ignored.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/voucher/esim' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'
Response Response Example
200 - Esim voucher - Esim voucher
{
  "data": [
    {
      "package_id": "jaco-mobile-7days-1gb",
      "codes": [
        "BIXLAAAA",
        "BSXLAAAA"
      ],
      "booking_reference": "123"
    },
    {
      "package_id": "liberation-mobile-30days-3gb",
      "codes": [
        "1HKGDUMP"
      ],
      "booking_reference": "123"
    }
  ],
  "meta": {
    "message": "success"
  }
}

Request

Header Params
Authorization
string 
required
Example:
Bearer {{token}}
Content-Type
string 
required
Example:
application/json

Responses

🟢200Esim voucher
text/plain
Body
data
array [object {3}] 
required
package_id
string 
required
codes
array[string]
required
booking_reference
string 
required
meta
object 
required
message
string 
required
🟢200Esim voucher error
Modified at 2025-05-07 10:26:40
Previous
Update eSIM brand
Next
Refund Request
Built with