eSIM API

curl -X GET "https://sandbox.flightota.com/api/v1/ping" \
  -H "X-Api-Key: $FLIGHTOTA_API_KEY" \
  -H "X-Api-Secret: $FLIGHTOTA_API_SECRET" \
  -H "Accept: application/json"

{
  "ok": true,
  "partner": "PTR-000020",
  "key_id": "ak_test_your_key_id",
  "environment": "test",
  "from_ip": "203.0.113.10",
  "server_time": "2026-09-22T13:25:02+00:00"
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Check the key and secret; issue a new key if revoked."
  }
}

curl -X GET "https://sandbox.flightota.com/api/v1/esims/places" \
  -H "X-Api-Key: $FLIGHTOTA_API_KEY" \
  -H "X-Api-Secret: $FLIGHTOTA_API_SECRET" \
  -H "Accept: application/json"

{
  "currency": "BDT",
  "places": [
    {
      "code": "AE",
      "name": "United Arab Emirates",
      "kind": "country",
      "image": "https://…/places/ae.png",
      "plans": 12,
      "from": {
        "amount": 38500,
        "currency": "BDT"
      }
    }
  ]
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Check the key and secret; issue a new key if revoked."
  }
}

curl -X GET "https://sandbox.flightota.com/api/v1/esims/places/AE" \
  -H "X-Api-Key: $FLIGHTOTA_API_KEY" \
  -H "X-Api-Secret: $FLIGHTOTA_API_SECRET" \
  -H "Accept: application/json"

{
  "place": {
    "code": "AE",
    "name": "United Arab Emirates",
    "kind": "country",
    "image": "https://…/places/ae.png",
    "plans": [
      {
        "id": "burj-mobile-7days-1gb",
        "title": "1 GB - 7 days",
        "data": "1 GB",
        "amount_mb": 1024,
        "days": 7,
        "unlimited": false,
        "voice": null,
        "text": null,
        "operator": "Burj Mobile",
        "operator_image": "https://…/operators/burj-mobile.png",
        "plan_type": "data",
        "activation": "first-usage",
        "kyc": false,
        "rechargeable": true,
        "info": [
          "5G data-only eSIM.",
          "Rechargeable online with no expiry.",
          "Operates on the Etisalat network in the United Arab Emirates."
        ],
        "coverage": [
          "AE"
        ],
        "price": {
          "amount": 38500,
          "currency": "BDT"
        }
      }
    ]
  }
}

{
  "error": {
    "code": "place_not_found",
    "message": "A place with no plans."
  }
}

curl -X POST "https://sandbox.flightota.com/api/v1/esims/orders" \
  -H "X-Api-Key: $FLIGHTOTA_API_KEY" \
  -H "X-Api-Secret: $FLIGHTOTA_API_SECRET" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: sim-7731" \
  -H "Content-Type: application/json" \
  -d '{
  "place_code": "AE",
  "plan_id": "burj-mobile-7days-1gb",
  "quantity": 1,
  "email": "guest@example.com",
  "name": "Arif Rahman",
  "client_reference": "SIM-7731"
}'

{
  "status": "issued",
  "order": {
    "order_ref": "TFS-4K7PQ2MX",
    "state": "issued",
    "created_at": "2026-09-22T14:40:03Z",
    "issued_at": "2026-09-22T14:40:05Z",
    "client_reference": "SIM-7731",
    "total": {
      "amount": 38500,
      "currency": "BDT"
    },
    "place": {
      "code": "AE",
      "name": "United Arab Emirates",
      "kind": "country"
    },
    "plan": {
      "id": "burj-mobile-7days-1gb",
      "title": "1 GB - 7 days",
      "data": "1 GB",
      "days": 7,
      "activation": "first-usage",
      "…": "…"
    },
    "quantity": 1,
    "validity_days": 7,
    "email": "guest@example.com",
    "sims": [
      {
        "iccid": "8910300000000012341",
        "lpa": "LPA:1$smdp.example.com$ABC-123-XYZ",
        "smdp_address": "smdp.example.com",
        "activation_code": "ABC-123-XYZ",
        "confirmation_code": null,
        "qr_url": "https://…/qr/ABC-123-XYZ.png",
        "apple_install_url": "https://esimsetup.apple.com/esim_qrcode_provisioning?carddata=LPA:1$smdp.example.com$ABC-123-XYZ",
        "apn": {
          "type": "automatic",
          "value": "internet"
        },
        "roaming": true
      }
    ],
    "installation": {
      "qr": "1. Go to Settings > Mobile Data…",
      "manual": "1. Go to Settings > Mobile Data > Add eSIM > Enter details manually…"
    }
  }
}

{
  "status": "pending",
  "order": {
    "order_ref": "TFS-…",
    "state": "ticketing",
    "sims": [],
    "…": "…"
  }
}

{
  "error": {
    "code": "idempotency_key_required",
    "message": "Add the header."
  }
}

curl -X GET "https://sandbox.flightota.com/api/v1/esims/orders/TFS-4K7PQ2MX" \
  -H "X-Api-Key: $FLIGHTOTA_API_KEY" \
  -H "X-Api-Secret: $FLIGHTOTA_API_SECRET" \
  -H "Accept: application/json"

{
  "order": {
    "order_ref": "TFS-4K7PQ2MX",
    "state": "issued",
    "…": "the shape above, with the SIM codes"
  }
}

{
  "error": {
    "code": "order_not_found",
    "message": "Another agency's reference."
  }
}

curl -X GET "https://sandbox.flightota.com/api/v1/esims/orders" \
  -H "X-Api-Key: $FLIGHTOTA_API_KEY" \
  -H "X-Api-Secret: $FLIGHTOTA_API_SECRET" \
  -H "Accept: application/json"

{
  "orders": [
    {
      "order_ref": "TFS-4K7PQ2MX",
      "state": "issued",
      "…": "…"
    }
  ],
  "page": 1,
  "per_page": 25,
  "total": 1,
  "last_page": 1
}

{
  "error": {
    "code": "unauthenticated",
    "message": "Check the key and secret; issue a new key if revoked."
  }
}