Submit top-up order - Airalo Developer Platform

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 object, which contains the following required fields:

package_id: The ID of the top-up package you want to purchase

iccid: The ICCID of the eSIM for which you want to purchase the top-up package.

You can also include an optional description field to provide additional information about the order.

The API will respond with a JSON object containing the details of the order, including the package ID, quantity, price, and other information.

The complete workflow for buying a top-up package:

GET {{url}}/{{version}}/sims to see the list of purchased eSIMs

GET {{url}}/{{version}}/sims/:iccid/topups to see the list of available top-ups for the eSIMs

POST {{url}}/{{version}}/orders/topups with the proper "iccid" and "package_id" values to purchase a top-up

GET {{url}}/{{version}}/sims/:iccid/packages to see the list of all packages for the eSIM, including the original package and top-ups

For more informations, best practices visit our FAQ page: https://airalopartners.zendesk.com/hc/en-us/sections/13207524820893-FAQ

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Submit Top-up Order: 200 OK

application/json

Body

Example

{
    "data": {
        "package_id": "bonbon-mobile-30days-3gb-topup",
        "quantity": "1",
        "type": "topup",
        "description": "Topup (89340000000000872)",
        "esim_type": "Prepaid",
        "validity": 30,
        "package": "Bonbon Mobile 2-3 GB - 30 Days",
        "data": "3 GB",
        "price": 10,
        "created_at": "2023-02-07 07:42:17",
        "id": 174,
        "code": "20230207-000174",
        "currency": "USD",
        "manual_installation": "",
        "qrcode_installation": "",
        "installation_guides": {
            "en": "http://airalo.local:8080/installation-guide"
        }
    },
    "meta": {
        "message": "success"
    }
}

🟠422Submit Top-up Order: 422 (Purchase limit exceeded)

🟠422Submit Top-up Order: 422 (Required fields are missing)

🟠422Submit Top-up Order: 422 (Invalid package id)

🟠422Submit Top-up Order: 422 (Recycled sim)