Airalo Developer Platform
  1. Endpoints
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • 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
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: 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
        POST
      • Get packages
        GET
      • Get compatible device list
        GET
      • Future Orders
        POST
      • eSIM voucher
        POST
      • Get eSIM
        GET
      • Cancel future orders
        POST
      • Submit order
        POST
      • Refund Request
        POST
      • Get installation instructions
        GET
      • Submit order async
        POST
      • Get usage (data, text & voice)
        GET
      • Submit top-up order
        POST
      • Update eSIM brand
        PUT
    • Guides
      • Step #1 - Authentication
    • 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
    • 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
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Endpoints

Refund Request

POST
/v2/refund

Overview#

The Airalo Refund API makes it simple to request refunds for eSIMs. This guide walks you through everything you need to know, including the API endpoint, request and response formats, error handling, and sample requests.

⚠️ Important Disclaimer#

The Refund API helps streamline the refund request process by reducing manual effort. However, submitting a request through this API does not guarantee approval.
Each refund request is individually reviewed based on Airalo's Refund Policy to ensure it meets all terms and conditions. Refund approvals remain subject to Airalo’s internal policies and decisions.
If your request meets the contract terms, the refund will be credited to your account as Airalo credits, ready to use for future transactions.
Please note that access to this API requires a contract amendment. Make sure you have the right agreement in place before intergrating the service into you workflow.

Request

Header Params
Accept
string 
optional
Indicates the expected response format.
Example:
application/json
Authorization
string 
optional
Bearer token for authenticating the request
Example:
Bearer {{token}}
Body Params text/plain
Example

Required Fields

iccids

Type: array
Description: An array of ICCIDs (max 5). Each ICCID must be a string of digits.

reason

Type: string
Description: The reason for the refund. Accepted values listed below.

Accepted Reason Values:

INSTALLATION_FAILURE
NO_COVERAGE
APN_FAILURE
TRIP_CANCELLATION
INTERMITTENT_CONNECTION
BLOCKED_NETWORK
CHANGE_OF_PLAN
DELETED_ESIM
EARLY_EXPIRY
HOTSPOT_NOT_WORKING
IMSI_CHANGE
INCOMPATIBLE_DEVICE
LOCKED_DEVICE
NO_VOICE_TEXT_SERVICES
OVERCHARGED
SLOW_SPEED
TOP_UP_PACKAGE_FAILURE
UNKNOWN_CHARGES
WRONG_PURCHASE
UNABLE_TO_ACCESS_APPS
SERVICE_DEGRADATION
QR_ISSUE_PARTNERS
OTHERS

Optional Fields

notes

Type: string
Description: Additional notes (max 255 characters). Required if reason is "OTHERS".

email

Type: string
Description: Optional email address for follow-up (must be a valid email).
Example: { "iccids": [ "894000000000001", "894000000000002" ], "reason": "SERVICE_ISSUES", "notes": "Connection issues in the region." }

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/refund' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: text/plain' \
--data-raw '{
  "iccids": [
    "894000000000001",
    "894000000000002"
  ],
  "reason": "SERVICE_ISSUES",
  "notes": "Connection issues in the region."
}'

Responses

🟢202Accepted
application/json
Body
data
object 
required
refund_id
string 
required
created_at
string 
required
meta
object 
required
message
string 
required
Example
{
    "data": {
        "refund_id": "12345",
        "created_at": "2024-10-12 09:30"
    },
    "meta": {
        "message": "success"
    }
}
🟠422Parameter Error
🟠422Parameter Error
🟠422Parameter Error
Previous
Submit order
Next
Get installation instructions
Built with