> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dancity.app/llms.txt
> Use this file to discover all available pages before exploring further.

# eSIM packages for region

> eSIM packages for region



## OpenAPI

````yaml GET /api/v1/esim/packages
openapi: 3.1.0
info:
  title: Dancity API
  description: >-
    Paths below match the server base URL + global prefix `api`. Merchant:
    `Authorization: Bearer dcy_live_...` and `channel: API`. App: JWT. See
    Guides for flows.
  version: 1.0.0
servers:
  - url: https://api.dancity.app
    description: Production
  - url: http://localhost:6565
    description: Local development
security: []
tags:
  - name: VAS
    description: >-
      Merchant API (`/api/v1`): catalog GETs (wallet, services, products, plans)
      and purchase routes; `channel: API` on POST buys; app education & betting
      where listed
  - name: Products & services
    description: 'Catalog GETs: all services; products and plans with optional query filters'
  - name: Wallet
    description: Get wallet by id (JWT)
  - name: Transactions
    description: Fetch your transactions and requery one by id for current status
  - name: Betting
    description: Betting funding
  - name: Education
    description: Education pins
  - name: eSIM
    description: eSIM catalog and purchase
  - name: Webhook
    description: Outbound events Dancity POSTs to your configured HTTPS URL
paths:
  /api/v1/esim/packages:
    get:
      tags:
        - eSIM
      summary: eSIM packages for region
      parameters:
        - name: regionCode
          in: query
          required: true
          description: >-
            Region code from GET /api/v1/esim/regions (e.g. `NG` for Nigeria,
            `EU-42` for a multi-country region).
          schema:
            type: string
            example: NG
        - name: regionType
          in: query
          description: >-
            Region classification from the regions list — pass the selected
            region's `type` value. `country` = single country (default),
            `multi-country` = regional bundle covering multiple countries.
          schema:
            type: string
            enum:
              - country
              - multi-country
              - global
            default: country
            example: country
        - name: type
          in: query
          description: >-
            Package category: `BASE` = new eSIM to install, `TOPUP` = add data
            to an existing eSIM. Defaults to `BASE`.
          schema:
            type: string
            enum:
              - BASE
              - TOPUP
            default: BASE
            example: BASE
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                success: true
                message: Packages fetched
                data:
                  - packageCode: NG-1GB-7D
                    name: Nigeria 1GB 7 Days
                    dataAmount: 1GB
                    validity: 7 days
                    price: 3000
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                success: false
                message: Invalid API key or IP not allowlisted
                statusCode: 401
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                success: false
                message: Sorry, something went wrong. Please try again later
                statusCode: 500
      security:
        - DancityApiKey: []
components:
  securitySchemes:
    DancityApiKey:
      type: http
      scheme: bearer
      bearerFormat: dcy_live_...
      description: Merchant API key from the Dancity dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.