1. REST API
Airalo Partner API
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Developer feedback
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • 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
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Go live checklist
    • Sandbox mode
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Place order
        • Future orders
        • Submit order
        • Submit order async
        • eSIM voucher
      • Request refund
        • Request refund
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Top up eSIM
        • Get top-up package list
        • Submit top-up order
      • Manage orders
        • Get order list
        • Get order
        • Cancel future orders
        • Future Orders
      • Manage eSIMs
        • Update eSIM brand
        • Get eSIMs list
        • Get eSIM package history
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
      • Notifications
        • Airalo webhooks opt-in and flow
        • Webhooks guide
        • Webhook definition
        • Notification: Low data
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Credit limit
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Async orders
          • Opt in
          • Get notification details
          • Opt out
        • Webhook simulator
      • Check balance
        • Get balance
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Guides
      • How to install the Airalo Plugin for WooCommerce
      • How to customize the "My eSIMs" page colors in WooCommerce
      • How to convert prices into your local currency
  • Whitelabel eSIM platform
    • Whitelabel eSIM platform integration guide
  1. REST API

Go live checklist

Partner journey summary#

1.
Apply to become a partner. You'll be connected with a dedicated account manager.
2.
Your account manager will review your application and guide you through initial discussions.
3.
Legal and contractual requirements are verified and confirmed.
4.
Your company will be set up in our system as an API partner, with Sandbox mode enabled.
5.
Log in to the Partner Platform and collect your API credentials.
6.
Begin your integration using our REST API, SDKs, or eCommerce plugins.
7.
Test all features thoroughly in Sandbox mode.
8.
Review and complete the Go Live Checklist.
9.
Contact your account manager to switch your account to Production (Live) mode.

Go live checklist#

Before switching to Production mode (Live mode), make sure you’ve covered the go live checklist, ensuring that your system is production ready. Visit Sandbox vs Production mode to udnetstand the differences between modes.
1.
Provide your live eSIM store (or App store) URL for review
2.
Select your primary customer segment.
Leisure travelers
Business travelers
Other
If 'Other' is selected, please provide your customer segment i.e.: Pilots, seafarers, digital nomads, etc..
3.
Confirm you have received and signed your contract.
4.
Validate your end-to-end Sandbox flow: browse → order → install → top-up. (End-to-end flow)
5.
Validate your system can accept, process, and complete live orders. (Submit orders)
6.
Check that your integration successfully handles reauthentication when access tokens expire. (Request access token)
7.
Validate monitoring logs errors, requests, and response data. (Error handling)
8.
Confirm your integration handles edge cases (e.g. Invalid ICCIDs). (Error handling)
9.
Review and confirm that packages are synced hourly to maintain accurate stock and availability. (GET packages)
10.
Confirm that webhooks for low-data alerts are configured to notify customers and encourage top-ups. (Webhook notifications)
11.
Validate your system gracefully handle and process common API error codes (4xx/5xx).
12.
Verify that safeguards are in place to prevent accidental duplicate orders from being submitted to the API.
Modified at 2026-05-29 08:18:33
Previous
Error handling
Next
Sandbox mode
Built with