eSIM voucher

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.

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

Example

{
    "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"
    }
}

🟢200Esim voucher error

Request

Request samples

Responses