{
  "openapi": "3.0.3",
  "info": {
    "title": "Zetexa B2B eSIM API: core ordering flow",
    "version": "2026-11-19",
    "description": "The core ordering flow of the Zetexa B2B API for partners (authenticate, browse countries and packages, place an order, read the eSIM activation details, check orders, usage and balance) and the airport lounge, fast track and meet & greet calls.\n\nAll examples use placeholder values and are illustrative. Your Zetexa integration contact issues your credentials and confirms the headers, mandatory fields, limits, units and Create-Order version for your account.\n\nNot on this page: top-ups for an existing eSIM, wallet transactions, per-plan data usage, the top-up package list, token validation, KYC, refunds, local lines, ordering local SIMs, booking and cancelling ancillary services, and webhooks. Your Zetexa integration contact provides the reference for the ones in your agreement.\n\nEvery example value is a placeholder. The `version` is the date of the reference page this file was built from.",
    "contact": {
      "name": "Zetexa partnerships",
      "url": "https://zetexa.com/en/contact-us"
    }
  },
  "externalDocs": {
    "description": "API reference",
    "url": "https://zetexa.com/en/docs/api-reference"
  },
  "servers": [
    {
      "url": "https://{host}",
      "description": "Zetexa supplies the real host for sandbox and production with your credentials.",
      "variables": {
        "host": {
          "default": "BASE_URL",
          "description": "Placeholder: replace it with the host Zetexa gives you."
        }
      }
    }
  ],
  "security": [
    {
      "AccessToken": [],
      "SessionToken": []
    }
  ],
  "tags": [
    {
      "name": "Get started"
    },
    {
      "name": "Sell eSIMs"
    },
    {
      "name": "After the sale"
    },
    {
      "name": "Airport services"
    }
  ],
  "paths": {
    "/v1/Create-Token": {
      "post": {
        "operationId": "create-token",
        "tags": [
          "Get started"
        ],
        "summary": "Create a session token",
        "description": "Exchanges your account credentials for a session token. Send only the AccessToken header on this call.\n\n403 when the AccessToken header is missing.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "session_token": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "session_token": "<SESSION_TOKEN>"
                }
              }
            }
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "security": [
          {
            "AccessToken": []
          }
        ],
        "requestBody": {
          "required": true,
          "description": "Fields: email: Your partner account email. password: Your partner account password.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "email": {
                    "type": "string"
                  },
                  "password": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "email",
                  "password"
                ]
              },
              "example": {
                "email": "partner@example.com",
                "password": "<PASSWORD>"
              }
            }
          }
        }
      }
    },
    "/v2/Countries-List": {
      "get": {
        "operationId": "countries-regions",
        "tags": [
          "Get started"
        ],
        "summary": "List countries and regions",
        "description": "Lists the countries or regions you can sell eSIM packages for. No parameters.\n\nRegion rows carry id, name and image only (no iso2 or iso3).\n\nErrors: 403 (AccessToken missing), 401 (session token missing or invalid).\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number"
                          },
                          "name": {
                            "type": "string"
                          },
                          "iso2": {
                            "type": "string"
                          },
                          "iso3": {
                            "type": "string"
                          },
                          "image": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "message": "Data Fetched Successfully",
                  "data": [
                    {
                      "id": 1,
                      "name": "Exampleland",
                      "iso2": "XX",
                      "iso3": "XXX",
                      "image": "https://<IMAGE_HOST>/flag.svg"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        }
      }
    },
    "/v2/Regions-List": {
      "get": {
        "operationId": "countries-regions-2",
        "tags": [
          "Get started"
        ],
        "summary": "List countries and regions",
        "description": "Lists the countries or regions you can sell eSIM packages for. No parameters.\n\nRegion rows carry id, name and image only (no iso2 or iso3).\n\nErrors: 403 (AccessToken missing), 401 (session token missing or invalid).\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": true
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        }
      }
    },
    "/v3/Packages-List": {
      "get": {
        "operationId": "packages",
        "tags": [
          "Sell eSIMs"
        ],
        "summary": "List packages",
        "description": "Lists the packages you can sell for a country or a region.\n\npackage_category is 1 for data-only packages and 2 for data, voice and SMS packages.\n\nA search with no match returns 200 with success: false and an empty data list.\n\n400 when filterby is missing, or when country_code or region_name is missing for the chosen filterby.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "currency_code": {
                      "type": "string"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "package_id": {
                            "type": "string"
                          },
                          "package_name": {
                            "type": "string"
                          },
                          "data": {
                            "type": "string"
                          },
                          "data_in_mb": {
                            "type": "number"
                          },
                          "call": {
                            "type": "number"
                          },
                          "call_in_seconds": {
                            "type": "number"
                          },
                          "sms": {
                            "type": "number"
                          },
                          "validity": {
                            "type": "number"
                          },
                          "coverage": {
                            "type": "string"
                          },
                          "price": {
                            "oneOf": [
                              {
                                "type": "number"
                              },
                              {
                                "type": "string"
                              }
                            ],
                            "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                          },
                          "network": {
                            "nullable": true
                          },
                          "status": {
                            "type": "boolean"
                          },
                          "fup_policy": {
                            "nullable": true
                          },
                          "countries": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "countryname": {
                                  "type": "string"
                                },
                                "countryiso2": {
                                  "type": "string"
                                }
                              },
                              "additionalProperties": true
                            }
                          },
                          "package_category": {
                            "type": "number"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "currency_code": "USD",
                  "data": [
                    {
                      "package_id": "<PACKAGE_ID>",
                      "package_name": "Exampleland 1 Day 1 GB",
                      "data": "1.0 GB",
                      "data_in_mb": 1024,
                      "call": 0,
                      "call_in_seconds": 0,
                      "sms": 0,
                      "validity": 1,
                      "coverage": "4G",
                      "price": 3.1,
                      "network": null,
                      "status": true,
                      "fup_policy": null,
                      "countries": [
                        {
                          "countryname": "Exampleland",
                          "countryiso2": "XX"
                        }
                      ],
                      "package_category": 1
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "A required field or parameter is missing or invalid. Errors look like {\"success\": false, \"message\": \"...\"} or {\"success\": false, \"errors\": [{\"field\": \"...\", \"message\": \"...\"}]}."
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "parameters": [
          {
            "name": "filterby",
            "in": "query",
            "required": true,
            "description": "Required. Country or Region.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "country_code",
            "in": "query",
            "required": false,
            "description": "Required when filterby is Country (the iso2 code from the country list).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region_name",
            "in": "query",
            "required": false,
            "description": "Required when filterby is Region.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "plan_name",
            "in": "query",
            "required": false,
            "description": "Optional integer: 1 for data-only plans, 2 for plans with data, voice and SMS.",
            "schema": {
              "type": "integer",
              "enum": [
                1,
                2
              ]
            }
          }
        ]
      }
    },
    "/v2/Create-Order": {
      "post": {
        "operationId": "create-order",
        "tags": [
          "Sell eSIMs"
        ],
        "summary": "Create an order",
        "description": "Orders one or more eSIM packages and returns the order together with the SIM details (ICCID and the LPA activation address). The QR code and the order details can also be fetched afterwards.\n\n400 \"package id Field Required\" when package_id is missing; 400 \"ICCID already allocated to customer\" when an ICCID is already in use; 401 and 403 as above.\n\nThe sims list also carries more fields per SIM (for example identifiers and per-line prices) and total is a symbol-prefixed string: read the currency from the order details, not from the symbol.\n\nAn earlier version, POST /v1/Create-Order, takes the same body but returns no SIM data: fetch it afterwards with the QR code or order details call.\n\nOrders for local SIMs and ancillary bookings use a separate order call (a v4 version) that is not covered here.\n\nCheck retry and duplicate-order behaviour with your integration contact before you retry an order after a timeout.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "order_id": {
                      "type": "string"
                    },
                    "total": {
                      "oneOf": [
                        {
                          "type": "number"
                        },
                        {
                          "type": "string"
                        }
                      ],
                      "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                    },
                    "status": {
                      "type": "string"
                    },
                    "sims": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "iccid": {
                            "type": "string"
                          },
                          "lpa_server": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "message": "Order Created successfully",
                  "order_id": "<ORDER_ID>",
                  "total": "$ 5.00",
                  "status": "Completed",
                  "sims": [
                    {
                      "iccid": "<ICCID>",
                      "lpa_server": "LPA:1$<SMDP_ADDRESS>$<MATCHING_ID>",
                      "status": "AFFECTED"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "A required field or parameter is missing or invalid. Errors look like {\"success\": false, \"message\": \"...\"} or {\"success\": false, \"errors\": [{\"field\": \"...\", \"message\": \"...\"}]}."
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "requestBody": {
          "required": true,
          "description": "Fields: package_id: Required. The package_id from the package list. country, first_name, last_name, address, email, quantity: Send these with every order. state, city, pincode, phone_number: Optional. reseller_orderid_name, reseller_orderid: Optional. Your own order reference.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "package_id": {
                    "type": "string"
                  },
                  "country": {
                    "type": "string"
                  },
                  "first_name": {
                    "type": "string"
                  },
                  "last_name": {
                    "type": "string"
                  },
                  "address": {
                    "type": "string"
                  },
                  "email": {
                    "type": "string"
                  },
                  "quantity": {
                    "type": "number"
                  },
                  "reseller_orderid": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "package_id",
                  "country",
                  "first_name",
                  "last_name",
                  "address",
                  "email",
                  "quantity"
                ]
              },
              "example": {
                "package_id": "<PACKAGE_ID>",
                "country": "XX",
                "first_name": "Jane",
                "last_name": "Doe",
                "address": "1 Example Street",
                "email": "jane.doe@example.com",
                "quantity": 1,
                "reseller_orderid": "PARTNER-0001"
              }
            }
          }
        }
      }
    },
    "/v1/get-qrcode-details": {
      "get": {
        "operationId": "qr-code",
        "tags": [
          "Sell eSIMs"
        ],
        "summary": "Get the QR code and activation details",
        "description": "Returns the activation details for an order, one entry per order line.\n\nTreat the QR code and the lpa_server value as secrets: whoever holds them can install the eSIM. Show them only to the customer who bought it.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "qr_codes": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "order_id": {
                            "type": "string"
                          },
                          "orderline_id": {
                            "type": "string"
                          },
                          "iccid": {
                            "type": "string"
                          },
                          "plan_id": {
                            "type": "string"
                          },
                          "plan_name": {
                            "type": "string"
                          },
                          "lpa_server": {
                            "type": "string"
                          },
                          "qr_code": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "message": "QR codes retrieved successfully",
                  "qr_codes": [
                    {
                      "order_id": "<ORDER_ID>",
                      "orderline_id": "<ORDERLINE_ID>",
                      "iccid": "<ICCID>",
                      "plan_id": "<PLAN_ID>",
                      "plan_name": "Exampleland 1 Day 1 GB",
                      "lpa_server": "LPA:1$<SMDP_ADDRESS>$<MATCHING_ID>",
                      "qr_code": "data:image/png;base64,<BASE64_PNG>"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "parameters": [
          {
            "name": "order_id",
            "in": "query",
            "required": true,
            "description": "Required. The order_id returned by Create an order.",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/Orders-List": {
      "get": {
        "operationId": "orders",
        "tags": [
          "After the sale"
        ],
        "summary": "List your orders",
        "description": "Lists the orders of your partner account.\n\norder_status values include Pending, Processing, Completed, Refund, Kyc Pending, NO EKYC and Payment Link Sent.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "total_pages": {
                      "type": "number"
                    },
                    "current_page": {
                      "type": "number"
                    },
                    "total_records": {
                      "type": "number"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "order_id": {
                            "type": "string"
                          },
                          "order_status": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          },
                          "currency": {
                            "type": "string"
                          },
                          "payment_method_name": {
                            "type": "string"
                          },
                          "total_net": {
                            "oneOf": [
                              {
                                "type": "number"
                              },
                              {
                                "type": "string"
                              }
                            ],
                            "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                          },
                          "tax": {
                            "oneOf": [
                              {
                                "type": "number"
                              },
                              {
                                "type": "string"
                              }
                            ],
                            "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                          },
                          "total_gross": {
                            "oneOf": [
                              {
                                "type": "number"
                              },
                              {
                                "type": "string"
                              }
                            ],
                            "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                          },
                          "created_on": {
                            "type": "string"
                          },
                          "total_value": {
                            "oneOf": [
                              {
                                "type": "number"
                              },
                              {
                                "type": "string"
                              }
                            ],
                            "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "message": "Order List fetched successfully",
                  "total_pages": 1,
                  "current_page": 1,
                  "total_records": 1,
                  "data": [
                    {
                      "order_id": "<ORDER_ID>",
                      "order_status": "Completed",
                      "email": "jane.doe@example.com",
                      "currency": "USD",
                      "payment_method_name": "wallet",
                      "total_net": "2.50",
                      "tax": "0.00",
                      "total_gross": "2.50",
                      "created_on": "2030-01-01T00:00:00",
                      "total_value": 2.5
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "description": "Optional page number.",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "required": false,
            "description": "Optional page size.",
            "schema": {
              "type": "integer"
            }
          }
        ]
      }
    },
    "/v2/Order-Details": {
      "post": {
        "operationId": "order-details",
        "tags": [
          "After the sale"
        ],
        "summary": "Get one order",
        "description": "Returns one order with its packages and the SIMs on it.\n\nAmounts are symbol-prefixed strings and the spacing can vary: read the currency field.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "order": {
                          "type": "object",
                          "properties": {
                            "order_id": {
                              "type": "string"
                            },
                            "currency": {
                              "type": "string"
                            },
                            "total_paid": {
                              "oneOf": [
                                {
                                  "type": "number"
                                },
                                {
                                  "type": "string"
                                }
                              ],
                              "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                            },
                            "order_status": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true
                        },
                        "packages": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "package_name": {
                                "type": "string"
                              },
                              "quantity": {
                                "type": "number"
                              },
                              "validity": {
                                "type": "number"
                              },
                              "sim_type": {
                                "type": "string"
                              },
                              "unit_price": {
                                "oneOf": [
                                  {
                                    "type": "number"
                                  },
                                  {
                                    "type": "string"
                                  }
                                ],
                                "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                              },
                              "simsdata": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "iccid": {
                                      "type": "string"
                                    },
                                    "lpa_server": {
                                      "type": "string"
                                    },
                                    "sim_status": {
                                      "type": "string"
                                    },
                                    "order_package_id": {
                                      "type": "string"
                                    },
                                    "package_id": {
                                      "type": "string"
                                    }
                                  },
                                  "additionalProperties": true
                                }
                              }
                            },
                            "additionalProperties": true
                          }
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "data": {
                    "order": {
                      "order_id": "<ORDER_ID>",
                      "currency": "USD",
                      "total_paid": "$ 2.50",
                      "order_status": "Completed"
                    },
                    "packages": [
                      {
                        "package_name": "Exampleland 1 Day 1 GB",
                        "quantity": 1,
                        "validity": 1,
                        "sim_type": "ESIM",
                        "unit_price": "$ 2.50",
                        "simsdata": [
                          {
                            "iccid": "<ICCID>",
                            "lpa_server": "LPA:1$<SMDP_ADDRESS>$<MATCHING_ID>",
                            "sim_status": "FREE",
                            "order_package_id": "<ORDER_PACKAGE_ID>",
                            "package_id": "<PACKAGE_ID>"
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "requestBody": {
          "required": true,
          "description": "Fields: order_id: Required. The order to read.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "order_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "order_id"
                ]
              },
              "example": {
                "order_id": "<ORDER_ID>"
              }
            }
          }
        }
      }
    },
    "/v2/ESim-Usage": {
      "post": {
        "operationId": "usage",
        "tags": [
          "After the sale"
        ],
        "summary": "Check eSIM usage and status",
        "description": "Returns the current usage counters and the status of one eSIM.\n\nsim_status values: UNUSED (not installed), BPP_INSTALLATION (installed), ENABLE (data on), DISABLE (data off) and DELETE (profile removed).\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "usage": {
                      "type": "object",
                      "properties": {
                        "sim_status": {
                          "type": "string"
                        },
                        "iccid": {
                          "type": "string"
                        },
                        "data": {
                          "type": "number"
                        },
                        "out_call": {
                          "type": "string"
                        },
                        "in_call": {
                          "type": "string"
                        },
                        "in_sms": {
                          "type": "string"
                        },
                        "out_sms": {
                          "type": "string"
                        },
                        "in_voip": {
                          "type": "string"
                        },
                        "out_voip": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "usage": {
                    "sim_status": "UNUSED",
                    "iccid": "<ICCID>",
                    "data": 0,
                    "out_call": "0",
                    "in_call": "0",
                    "in_sms": "0",
                    "out_sms": "0",
                    "in_voip": "0",
                    "out_voip": "0"
                  }
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "requestBody": {
          "required": true,
          "description": "Fields: iccid: Required. The ICCID of the eSIM.",
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "iccid": {
                    "type": "string"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "iccid"
                ]
              },
              "example": {
                "iccid": "<ICCID>"
              }
            }
          }
        }
      }
    },
    "/v1/Reseller-Balance": {
      "post": {
        "operationId": "balance",
        "tags": [
          "After the sale"
        ],
        "summary": "Read your wallet balance",
        "description": "Returns the balance of your partner wallet. No body.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "balance": {
                      "oneOf": [
                        {
                          "type": "number"
                        },
                        {
                          "type": "string"
                        }
                      ],
                      "description": "An amount: the reference page says it is a plain number, a numeric string or a symbol-prefixed string, depending on the call. Take the currency from the currency field."
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "message": "Reseller Balance fetched successfully",
                  "balance": 100
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        }
      }
    },
    "/v1/available-services": {
      "get": {
        "operationId": "ancillary-services",
        "tags": [
          "Airport services"
        ],
        "summary": "List airport lounge, fast track and meet & greet services",
        "description": "Lists the ancillary services enabled for your partner account: airport lounge (BusinessLounge), fast track (FastTrack) and meet & greet (MeetAndGreet).\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "service_name": {
                            "type": "string"
                          },
                          "display_name": {
                            "type": "string"
                          },
                          "service_description": {
                            "type": "string"
                          },
                          "reseller_id": {
                            "type": "string"
                          },
                          "agent_id": {
                            "nullable": true
                          },
                          "status": {
                            "type": "boolean"
                          },
                          "service_image_url": {
                            "nullable": true
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "message": "Available services fetched successfully.",
                  "data": [
                    {
                      "service_name": "BusinessLounge",
                      "display_name": "BusinessLounge",
                      "service_description": "Premium Business Lounge",
                      "reseller_id": "<RESELLER_ID>",
                      "agent_id": null,
                      "status": true,
                      "service_image_url": null
                    },
                    {
                      "service_name": "FastTrack",
                      "display_name": "FastTrack",
                      "service_description": "Fast Track Services",
                      "reseller_id": "<RESELLER_ID>",
                      "agent_id": null,
                      "status": true,
                      "service_image_url": "https://<IMAGE_HOST>/service.png"
                    },
                    {
                      "service_name": "MeetAndGreet",
                      "display_name": "MeetAndGreet",
                      "service_description": "Meet and greet Services",
                      "reseller_id": "<RESELLER_ID>",
                      "agent_id": null,
                      "status": true,
                      "service_image_url": "https://<IMAGE_HOST>/service.png"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          }
        },
        "parameters": [
          {
            "name": "reseller_id",
            "in": "query",
            "required": false,
            "description": "Your partner account id, issued by Zetexa.",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/v1/get-available-plans": {
      "get": {
        "operationId": "ancillary-plans",
        "tags": [
          "Airport services"
        ],
        "summary": "List lounge, fast track and meet & greet plans at an airport",
        "description": "Lists the lounge, fast track and meet & greet plans you can sell at one airport, grouped by service family, with prices, ages, opening times, facilities and cancellation rules.\n\nPlans come back grouped by family under data.services: BusinessLounge, FastTrack and MeetAndGreet. All three families have the same shape. A meet & greet plan is shown here; a lounge plan also carries airportName and usually an empty cancellationFees list (see the lounge page for its sample). The family name is written FastTrack in service_name, display_name and as the key under data.services; a plan name is free text and can read \"Fast Track\".\n\nThe last element of each family list is an object with minimum_started_from, the lowest starting price for that family. A large airport can return more than twenty plans in one family.\n\nprice holds the adult, child and infant price in the requested currency; infantAge, childAge and adultAge give the age bands. isNonRefundable, cancellationFees (hours before the service time and the fee in percent) and preOrderPeriodInMinutes are the booking rules for the plan: show them to the customer before checkout.\n\nbooking_fields lists the details to collect for a booking, with a validator pattern for each. weekSchedule has one entry for each weekday (one is shown here). The real response also carries fields about your own cost and a total_services count; they are not shown here.\n\nWhen no services are found for an airport the API returns a 404 error: treat it as \"no services at this airport\", not as a failure of your integration.\n\nCreating and cancelling an ancillary booking is not covered on this page.\n\nThe schemas are inferred from the documented examples (types only, extra fields may appear). Only the parameters the reference page calls Required are marked required: use the API reference page for what each field means.\n\nThe example response shows one service family (MeetAndGreet); BusinessLounge and FastTrack have the same shape.",
        "responses": {
          "200": {
            "description": "Success. A 200 can still carry success: false, so check the success field and not the status alone.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "message": {
                      "type": "string"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "airport_code": {
                          "type": "string"
                        },
                        "currency_code": {
                          "type": "string"
                        },
                        "language": {
                          "type": "string"
                        },
                        "services": {
                          "type": "object",
                          "properties": {
                            "MeetAndGreet": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "addons_service": {
                                    "type": "object",
                                    "properties": {
                                      "plan_id": {
                                        "type": "string"
                                      },
                                      "service_id": {
                                        "type": "string"
                                      },
                                      "name": {
                                        "type": "string"
                                      },
                                      "service_name": {
                                        "type": "string"
                                      },
                                      "display_name": {
                                        "type": "string"
                                      },
                                      "shortDescription": {
                                        "type": "string"
                                      },
                                      "description": {
                                        "type": "string"
                                      },
                                      "meetingPoint": {
                                        "type": "string"
                                      },
                                      "terminalName": {
                                        "type": "string"
                                      },
                                      "serviceDirection": {
                                        "type": "string"
                                      },
                                      "price": {
                                        "type": "object",
                                        "properties": {
                                          "adult": {
                                            "type": "number"
                                          },
                                          "child": {
                                            "type": "number"
                                          },
                                          "infant": {
                                            "type": "number"
                                          }
                                        },
                                        "additionalProperties": true
                                      },
                                      "isNonRefundable": {
                                        "type": "boolean"
                                      },
                                      "preOrderPeriodInMinutes": {
                                        "type": "number"
                                      },
                                      "serviceCapacity": {
                                        "type": "number"
                                      },
                                      "isServiceLimitedCapacity": {
                                        "type": "boolean"
                                      },
                                      "maxPassengersCount": {
                                        "type": "number"
                                      },
                                      "facilities": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "properties": {
                                            "isEnabled": {
                                              "type": "boolean"
                                            },
                                            "isPaid": {
                                              "type": "boolean"
                                            },
                                            "name": {
                                              "type": "string"
                                            }
                                          },
                                          "additionalProperties": true
                                        }
                                      },
                                      "facilityShortDescription": {
                                        "type": "array",
                                        "items": {
                                          "type": "string"
                                        }
                                      },
                                      "facilityFullDescription": {
                                        "type": "array",
                                        "items": {
                                          "type": "string"
                                        }
                                      },
                                      "cancellationFees": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "properties": {
                                            "hoursBeforeServiceDateTime": {
                                              "type": "number"
                                            },
                                            "feeInPercents": {
                                              "type": "number"
                                            }
                                          },
                                          "additionalProperties": true
                                        }
                                      },
                                      "customsType": {
                                        "type": "object",
                                        "properties": {
                                          "international": {
                                            "type": "boolean"
                                          },
                                          "domestic": {
                                            "type": "boolean"
                                          },
                                          "schengen": {
                                            "type": "boolean"
                                          },
                                          "nonSchengen": {
                                            "type": "boolean"
                                          }
                                        },
                                        "additionalProperties": true
                                      },
                                      "airportIataCode": {
                                        "type": "string"
                                      },
                                      "serviceCurrencyCode": {
                                        "type": "string"
                                      },
                                      "prebookingFee": {
                                        "nullable": true
                                      },
                                      "plannedPrice": {
                                        "nullable": true
                                      },
                                      "isPlannedPriceEnabled": {
                                        "type": "boolean"
                                      },
                                      "weekSchedule": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "properties": {
                                            "weekDay": {
                                              "type": "string"
                                            },
                                            "dayNumber": {
                                              "type": "number"
                                            },
                                            "dayName": {
                                              "type": "string"
                                            },
                                            "isActive": {
                                              "type": "boolean"
                                            },
                                            "begin": {
                                              "type": "string"
                                            },
                                            "end": {
                                              "type": "string"
                                            }
                                          },
                                          "additionalProperties": true
                                        }
                                      },
                                      "unavailabilityPeriods": {
                                        "type": "array",
                                        "items": {}
                                      },
                                      "tax_percentage": {
                                        "type": "number"
                                      },
                                      "booking_fields": {
                                        "type": "array",
                                        "items": {
                                          "type": "object",
                                          "properties": {
                                            "name": {
                                              "type": "string"
                                            },
                                            "type": {
                                              "type": "string"
                                            },
                                            "label": {
                                              "type": "string"
                                            },
                                            "min_max": {
                                              "nullable": true
                                            },
                                            "options": {
                                              "nullable": true
                                            },
                                            "disabled": {
                                              "type": "boolean"
                                            },
                                            "required": {
                                              "type": "boolean"
                                            },
                                            "validator": {
                                              "type": "string"
                                            },
                                            "placeholder": {
                                              "type": "string"
                                            },
                                            "default_value": {
                                              "nullable": true
                                            }
                                          },
                                          "additionalProperties": true
                                        }
                                      },
                                      "infantAge": {
                                        "type": "object",
                                        "properties": {
                                          "bottom": {
                                            "nullable": true
                                          },
                                          "upper": {
                                            "type": "number"
                                          }
                                        },
                                        "additionalProperties": true
                                      },
                                      "childAge": {
                                        "type": "object",
                                        "properties": {
                                          "bottom": {
                                            "type": "number"
                                          },
                                          "upper": {
                                            "type": "number"
                                          }
                                        },
                                        "additionalProperties": true
                                      },
                                      "adultAge": {
                                        "type": "object",
                                        "properties": {
                                          "bottom": {
                                            "type": "number"
                                          },
                                          "upper": {
                                            "nullable": true
                                          }
                                        },
                                        "additionalProperties": true
                                      }
                                    },
                                    "additionalProperties": true
                                  },
                                  "policies": {
                                    "type": "object",
                                    "properties": {
                                      "terms_and_conditions": {
                                        "type": "string"
                                      },
                                      "privacy_policy": {
                                        "type": "string"
                                      },
                                      "refund_policy": {
                                        "type": "string"
                                      },
                                      "cancellation_policy": {
                                        "type": "string"
                                      }
                                    },
                                    "additionalProperties": true
                                  },
                                  "contact_information": {
                                    "type": "object",
                                    "properties": {
                                      "contact_information": {
                                        "type": "string"
                                      },
                                      "contact_email": {
                                        "type": "string"
                                      },
                                      "contact_phone": {
                                        "type": "string"
                                      },
                                      "contact_address": {
                                        "type": "string"
                                      }
                                    },
                                    "additionalProperties": true
                                  },
                                  "booking_fields": {
                                    "type": "array",
                                    "items": {
                                      "type": "object",
                                      "properties": {
                                        "name": {
                                          "type": "string"
                                        },
                                        "type": {
                                          "type": "string"
                                        },
                                        "label": {
                                          "type": "string"
                                        },
                                        "min_max": {
                                          "nullable": true
                                        },
                                        "options": {
                                          "nullable": true
                                        },
                                        "disabled": {
                                          "type": "boolean"
                                        },
                                        "required": {
                                          "type": "boolean"
                                        },
                                        "validator": {
                                          "type": "string"
                                        },
                                        "placeholder": {
                                          "type": "string"
                                        },
                                        "default_value": {
                                          "nullable": true
                                        }
                                      },
                                      "additionalProperties": true
                                    }
                                  }
                                },
                                "additionalProperties": true
                              }
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "additionalProperties": true
                },
                "example": {
                  "success": true,
                  "message": "Available services and plans fetched successfully.",
                  "data": {
                    "airport_code": "DXB",
                    "currency_code": "USD",
                    "language": "en",
                    "services": {
                      "MeetAndGreet": [
                        {
                          "addons_service": {
                            "plan_id": "<PLAN_ID>",
                            "service_id": "<SERVICE_ID>",
                            "name": "Example Meet & Greet (Arrival)",
                            "service_name": "MeetAndGreet",
                            "display_name": "MeetAndGreet",
                            "shortDescription": "- escort from the flight gate to the arrival hall;\n- queue-less passport control;\n- porter service.",
                            "description": "- escort from the flight gate to the arrival hall;\n- queue-less passport control;\n- porter service.",
                            "meetingPoint": "Arrival gate, a representative will be displaying your name.",
                            "terminalName": "3",
                            "serviceDirection": "Arrival",
                            "price": {
                              "adult": 120,
                              "child": 120,
                              "infant": 0
                            },
                            "isNonRefundable": false,
                            "preOrderPeriodInMinutes": 2880,
                            "serviceCapacity": 0,
                            "isServiceLimitedCapacity": false,
                            "maxPassengersCount": 0,
                            "facilities": [
                              {
                                "isEnabled": true,
                                "isPaid": false,
                                "name": "Name board"
                              },
                              {
                                "isEnabled": true,
                                "isPaid": false,
                                "name": "Passport control priority"
                              },
                              {
                                "isEnabled": true,
                                "isPaid": false,
                                "name": "Porter service to terminal exit"
                              }
                            ],
                            "facilityShortDescription": [
                              "Name board",
                              "Passport control priority",
                              "Porter service to terminal exit"
                            ],
                            "facilityFullDescription": [
                              "Name board",
                              "Passport control priority",
                              "Porter service to terminal exit"
                            ],
                            "cancellationFees": [
                              {
                                "hoursBeforeServiceDateTime": 8,
                                "feeInPercents": 100
                              },
                              {
                                "hoursBeforeServiceDateTime": 16,
                                "feeInPercents": 50
                              }
                            ],
                            "customsType": {
                              "international": true,
                              "domestic": false,
                              "schengen": false,
                              "nonSchengen": true
                            },
                            "airportIataCode": "DXB",
                            "serviceCurrencyCode": "USD",
                            "prebookingFee": null,
                            "plannedPrice": null,
                            "isPlannedPriceEnabled": false,
                            "weekSchedule": [
                              {
                                "weekDay": "Monday",
                                "dayNumber": 0,
                                "dayName": "Monday",
                                "isActive": true,
                                "begin": "00:00:00",
                                "end": "23:59:59"
                              }
                            ],
                            "unavailabilityPeriods": [],
                            "tax_percentage": 0,
                            "booking_fields": [
                              {
                                "name": "name",
                                "type": "text",
                                "label": "Full Name",
                                "min_max": null,
                                "options": null,
                                "disabled": false,
                                "required": true,
                                "validator": "^[A-Za-z]+(?:\\s[A-Za-z]+)+$",
                                "placeholder": "Enter Your Name",
                                "default_value": null
                              }
                            ],
                            "infantAge": {
                              "bottom": null,
                              "upper": 2
                            },
                            "childAge": {
                              "bottom": 2,
                              "upper": 12
                            },
                            "adultAge": {
                              "bottom": 12,
                              "upper": null
                            }
                          },
                          "policies": {
                            "terms_and_conditions": "",
                            "privacy_policy": "",
                            "refund_policy": "",
                            "cancellation_policy": ""
                          },
                          "contact_information": {
                            "contact_information": "",
                            "contact_email": "",
                            "contact_phone": "",
                            "contact_address": ""
                          },
                          "booking_fields": [
                            {
                              "name": "name",
                              "type": "text",
                              "label": "Full Name",
                              "min_max": null,
                              "options": null,
                              "disabled": false,
                              "required": true,
                              "validator": "^[A-Za-z]+(?:\\s[A-Za-z]+)+$",
                              "placeholder": "Enter Your Name",
                              "default_value": null
                            }
                          ]
                        },
                        {
                          "minimum_started_from": 120
                        }
                      ]
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "The session token is missing, invalid or expired."
          },
          "403": {
            "description": "The AccessToken header is missing."
          },
          "404": {
            "description": "No services found for the airport: treat it as no services there, not as a failure."
          }
        },
        "parameters": [
          {
            "name": "airportCode",
            "in": "query",
            "required": false,
            "description": "The IATA airport code, for example DXB.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "currencyCode",
            "in": "query",
            "required": false,
            "description": "The currency the prices are returned in, for example USD.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "language",
            "in": "query",
            "required": false,
            "description": "The language of names and descriptions, for example en.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "reseller_id",
            "in": "query",
            "required": false,
            "description": "Your partner account id.",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "AccessToken": {
        "type": "apiKey",
        "in": "header",
        "name": "AccessToken",
        "description": "Your long-lived partner access token, issued by Zetexa. Keep it on your server only."
      },
      "SessionToken": {
        "type": "http",
        "scheme": "bearer",
        "description": "The session token from Create-Token, sent as `Authorization: Bearer <SESSION_TOKEN>`. Valid for 10 days."
      }
    }
  }
}