> ## 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.

# Purchase eSIM

> Purchase eSIM



## OpenAPI

````yaml POST /api/v1/esim/purchase
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/purchase:
    post:
      tags:
        - eSIM
      summary: Purchase eSIM
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - packageCode
              properties:
                packageCode:
                  type: string
                  description: >-
                    Package code from GET /api/v1/esim/packages or GET
                    /api/v1/esim/topup-packages.
                  example: NG-1GB-30D
                customerRef:
                  type: string
                  description: Your internal reference for reconciliation.
                  example: ESIM-REF-001
                iccid:
                  type: string
                  description: >-
                    ICCID of the existing eSIM — required when purchasing a
                    TOPUP package.
                  example: '8960000000000000001'
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                success: true
                message: eSIM purchased
                data:
                  transactionId: TXN-20260506-008
                  status: SUCCESS
                  iccid: '8960000000000000001'
                  activationCode: LPA:1$smdp.example.com$ACTIVATION-CODE
        '400':
          description: Bad request
          content:
            application/json:
              example:
                success: false
                message: Validation failed
                statusCode: 400
        '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.