Airalo Developer Platform
  1. Place order
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • 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
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Place order
        • Submit order
          POST
        • Submit order async
          POST
        • Future orders
          POST
        • eSIM voucher
          POST
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Place top up order
        • Submit top-up order
        • Get top-up package list
        • Get eSIMs list
        • Get eSIM package history
      • Manage orders & eSIMs
        • Get order list
        • Cancel future orders
        • Get order
        • Update eSIM brand
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
      • Notifications
        • Airalo webhooks optin and flow
        • Understanding webhooks: Asynchronous communication for modern applications
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Check balance
        • Get balance
      • Refunds
        • Refund request
    • Guides
      • Step #1 - Authentication
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Product updates
    • Guides
      • How to install the Airalo Plugin for WooCommerce
      • How to set up prices in WooCommerce
      • How to customize the "My eSIMs" page colors in WooCommerce
      • How to convert prices into your local currency
      • How to finalize your WooCommerce shop setup
      • How to test in sandbox mode
      • How to go live
      • How to customize WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Place order

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

Responses

🟢200Esim voucher
text/plain
Body

🟢200Esim voucher error
Modified at 2025-07-10 09:50:35
Previous
Future orders
Next
Get eSIM
Built with