Airalo Developer Platform
  1. REST API
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
      • Get compatible device list
      • Get packages
      • Submit order
      • Submit order async
      • Submit top-up order
      • Get eSIM
      • Get data usage
      • Get installation instructions
      • Update eSIM brand
      • eSIM voucher
      • Refund Request
      • Future Orders
      • Cancel future orders
    • 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. REST API

Error handling

This page provides a comprehensive list of error codes that may be returned by the API during operation. Each error code is accompanied by a description of its meaning and potential causes, helping you to quickly identify and troubleshoot issues.
Error Code Structure
Code: A numeric or HTTP-based identifier that categorizes the error.
Reason: A detailed explanation of the error, including additional context when applicable.
Use this reference to understand why a particular request failed and to implement appropriate handling in your application, ensuring a robust and reliable integration with the API.

API Errors#

HTTP Code: 422 - Validation and Processing Errors
These errors occur when the request is well-formed but cannot be processed due to validation issues or other business rules.
CodeReason
11Insufficient Airalo Credit: {additional}
13The requested operator is currently undergoing maintenance. Please try again later.
14Invalid checksum: {additional}
23The requested top-up has been disabled by the operator. {additional}
33Insufficient stock of eSIMs remaining: {additional}. Please try your request again later.
34The requested eSIM package is invalid or it is currently out of stock. Please try again later.
43Bad request. {additional} Please check your input and try again.
53Something unexpected happened. We're working to resolve the issue. Please try again later.
73The eSIM with iccid {additional} has been recycled. It can no longer be used or topped up.

HTTP Code: 429 - Too Many Requests#

This error occurs when too many requests are made in a short period, exceeding the rate limit.
CodeReason
429Too Many Attempts (rate limit)

HTTP Codes: 5xx - Server Errors#

These errors are rare but may indicate a temporary outage or server issue. If a 5xx error persists, please check the status page or contact support.
HTTP CodeReason
500Internal Server Error
502Bad Gateway
503Service Unavailable
504Gateway Timeout
Modified at 2025-05-12 15:00:31
Previous
Rate limits
Next
Step #1 - Authentication
Built with