Zendit API

naftiko: 1.0.0-alpha2
info:
  label: Zendit API
  description: The Zendit API provides programmatic access to a global prepaid ecosystem, enabling mobile credit top-ups,
    data packages, digital gift cards, prepaid utility bill payments, and eSIM products through a unified integration.
  tags:
  - Zendit
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: zendit
    baseUri: https://api.zendit.io/v1
    description: Zendit API HTTP API.
    authentication:
      type: bearer
      token: '{{ZENDIT_TOKEN}}'
    resources:
    - name: balance
      path: /balance
      operations:
      - name: getbalance
        method: GET
        description: Zendit Get Balance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: brands
      path: /brands
      operations:
      - name: listbrands
        method: GET
        description: Zendit List Brands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: brands-brand
      path: /brands/{brand}
      operations:
      - name: getbrand
        method: GET
        description: Zendit Get Brand
        inputParameters:
        - name: brand
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: brands-brand-redemptioninstructions
      path: /brands/{brand}/redemptionInstructions
      operations:
      - name: getbrandredemptioninstructions
        method: GET
        description: Zendit Get Brand Redemption Instructions
        inputParameters:
        - name: brand
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: topups-offers
      path: /topups/offers
      operations:
      - name: listtopupoffers
        method: GET
        description: Zendit List Topup Offers
        inputParameters:
        - name: brand
          in: query
          type: string
        - name: subType
          in: query
          type: string
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: topups-offers-offerid
      path: /topups/offers/{offerId}
      operations:
      - name: gettopupoffer
        method: GET
        description: Zendit Get Topup Offer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: topups-purchases
      path: /topups/purchases
      operations:
      - name: listtopuppurchases
        method: GET
        description: Zendit List Topup Purchases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createtopuppurchase
        method: POST
        description: Zendit Create Topup Purchase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: topups-purchases-transactionid
      path: /topups/purchases/{transactionId}
      operations:
      - name: gettopuppurchase
        method: GET
        description: Zendit Get Topup Purchase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: esim-offers
      path: /esim/offers
      operations:
      - name: listesimoffers
        method: GET
        description: Zendit List ESIM Offers
        inputParameters:
        - name: regions
          in: query
          type: string
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: esim-offers-offerid
      path: /esim/offers/{offerId}
      operations:
      - name: getesimoffer
        method: GET
        description: Zendit Get ESIM Offer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: esim-purchases
      path: /esim/purchases
      operations:
      - name: listesimpurchases
        method: GET
        description: Zendit List ESIM Purchases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createesimpurchase
        method: POST
        description: Zendit Create ESIM Purchase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: esim-purchases-transactionid
      path: /esim/purchases/{transactionId}
      operations:
      - name: getesimpurchase
        method: GET
        description: Zendit Get ESIM Purchase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: esim-purchases-transactionid-qrcode
      path: /esim/purchases/{transactionId}/qrcode
      operations:
      - name: getesimqrcode
        method: GET
        description: Zendit Get ESIM QR Code
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: esim-iccid-plans
      path: /esim/{iccId}/plans
      operations:
      - name: getesimplans
        method: GET
        description: Zendit Get ESIM Plans
        inputParameters:
        - name: iccId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: esim-purchases-transactionid-refund
      path: /esim/purchases/{transactionId}/refund
      operations:
      - name: getesimrefund
        method: GET
        description: Zendit Get ESIM Refund
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createesimrefund
        method: POST
        description: Zendit Create ESIM Refund
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: vouchers-offers
      path: /vouchers/offers
      operations:
      - name: listvoucheroffers
        method: GET
        description: Zendit List Voucher Offers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: vouchers-offers-offerid
      path: /vouchers/offers/{offerId}
      operations:
      - name: getvoucheroffer
        method: GET
        description: Zendit Get Voucher Offer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: vouchers-purchases
      path: /vouchers/purchases
      operations:
      - name: listvoucherpurchases
        method: GET
        description: Zendit List Voucher Purchases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createvoucherpurchase
        method: POST
        description: Zendit Create Voucher Purchase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: vouchers-purchases-transactionid
      path: /vouchers/purchases/{transactionId}
      operations:
      - name: getvoucherpurchase
        method: GET
        description: Zendit Get Voucher Purchase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions
      path: /transactions
      operations:
      - name: listtransactions
        method: GET
        description: Zendit List Transactions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: transactions-transactionid
      path: /transactions/{transactionId}
      operations:
      - name: gettransaction
        method: GET
        description: Zendit Get Transaction
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: tools-phonenumberlookup-msisdn
      path: /tools/phonenumberlookup/{msisdn}
      operations:
      - name: lookupphonenumber
        method: GET
        description: Zendit Lookup Phone Number
        inputParameters:
        - name: msisdn
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: reports
      path: /reports
      operations:
      - name: createreport
        method: POST
        description: Zendit Create Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: reports-reportid
      path: /reports/{reportId}
      operations:
      - name: getreport
        method: GET
        description: Zendit Get Report
        inputParameters:
        - name: reportId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: reports-reportid-download
      path: /reports/{reportId}/download
      operations:
      - name: downloadreport
        method: GET
        description: Zendit Download Report
        inputParameters:
        - name: reportId
          in: path
          type: string
          required: true
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: zendit-rest
    description: REST adapter for Zendit API.
    resources:
    - path: /balance
      name: getbalance
      operations:
      - method: GET
        name: getbalance
        description: Zendit Get Balance
        call: zendit.getbalance
        outputParameters:
        - type: object
          mapping: $.
    - path: /brands
      name: listbrands
      operations:
      - method: GET
        name: listbrands
        description: Zendit List Brands
        call: zendit.listbrands
        outputParameters:
        - type: object
          mapping: $.
    - path: /brands/{brand}
      name: getbrand
      operations:
      - method: GET
        name: getbrand
        description: Zendit Get Brand
        call: zendit.getbrand
        with:
          brand: rest.brand
        outputParameters:
        - type: object
          mapping: $.
    - path: /brands/{brand}/redemptionInstructions
      name: getbrandredemptioninstructions
      operations:
      - method: GET
        name: getbrandredemptioninstructions
        description: Zendit Get Brand Redemption Instructions
        call: zendit.getbrandredemptioninstructions
        with:
          brand: rest.brand
        outputParameters:
        - type: object
          mapping: $.
    - path: /topups/offers
      name: listtopupoffers
      operations:
      - method: GET
        name: listtopupoffers
        description: Zendit List Topup Offers
        call: zendit.listtopupoffers
        outputParameters:
        - type: object
          mapping: $.
    - path: /topups/offers/{offerId}
      name: gettopupoffer
      operations:
      - method: GET
        name: gettopupoffer
        description: Zendit Get Topup Offer
        call: zendit.gettopupoffer
        outputParameters:
        - type: object
          mapping: $.
    - path: /topups/purchases
      name: listtopuppurchases
      operations:
      - method: GET
        name: listtopuppurchases
        description: Zendit List Topup Purchases
        call: zendit.listtopuppurchases
        outputParameters:
        - type: object
          mapping: $.
    - path: /topups/purchases
      name: createtopuppurchase
      operations:
      - method: POST
        name: createtopuppurchase
        description: Zendit Create Topup Purchase
        call: zendit.createtopuppurchase
        outputParameters:
        - type: object
          mapping: $.
    - path: /topups/purchases/{transactionId}
      name: gettopuppurchase
      operations:
      - method: GET
        name: gettopuppurchase
        description: Zendit Get Topup Purchase
        call: zendit.gettopuppurchase
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/offers
      name: listesimoffers
      operations:
      - method: GET
        name: listesimoffers
        description: Zendit List ESIM Offers
        call: zendit.listesimoffers
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/offers/{offerId}
      name: getesimoffer
      operations:
      - method: GET
        name: getesimoffer
        description: Zendit Get ESIM Offer
        call: zendit.getesimoffer
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/purchases
      name: listesimpurchases
      operations:
      - method: GET
        name: listesimpurchases
        description: Zendit List ESIM Purchases
        call: zendit.listesimpurchases
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/purchases
      name: createesimpurchase
      operations:
      - method: POST
        name: createesimpurchase
        description: Zendit Create ESIM Purchase
        call: zendit.createesimpurchase
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/purchases/{transactionId}
      name: getesimpurchase
      operations:
      - method: GET
        name: getesimpurchase
        description: Zendit Get ESIM Purchase
        call: zendit.getesimpurchase
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/purchases/{transactionId}/qrcode
      name: getesimqrcode
      operations:
      - method: GET
        name: getesimqrcode
        description: Zendit Get ESIM QR Code
        call: zendit.getesimqrcode
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/{iccId}/plans
      name: getesimplans
      operations:
      - method: GET
        name: getesimplans
        description: Zendit Get ESIM Plans
        call: zendit.getesimplans
        with:
          iccId: rest.iccId
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/purchases/{transactionId}/refund
      name: getesimrefund
      operations:
      - method: GET
        name: getesimrefund
        description: Zendit Get ESIM Refund
        call: zendit.getesimrefund
        outputParameters:
        - type: object
          mapping: $.
    - path: /esim/purchases/{transactionId}/refund
      name: createesimrefund
      operations:
      - method: POST
        name: createesimrefund
        description: Zendit Create ESIM Refund
        call: zendit.createesimrefund
        outputParameters:
        - type: object
          mapping: $.
    - path: /vouchers/offers
      name: listvoucheroffers
      operations:
      - method: GET
        name: listvoucheroffers
        description: Zendit List Voucher Offers
        call: zendit.listvoucheroffers
        outputParameters:
        - type: object
          mapping: $.
    - path: /vouchers/offers/{offerId}
      name: getvoucheroffer
      operations:
      - method: GET
        name: getvoucheroffer
        description: Zendit Get Voucher Offer
        call: zendit.getvoucheroffer
        outputParameters:
        - type: object
          mapping: $.
    - path: /vouchers/purchases
      name: listvoucherpurchases
      operations:
      - method: GET
        name: listvoucherpurchases
        description: Zendit List Voucher Purchases
        call: zendit.listvoucherpurchases
        outputParameters:
        - type: object
          mapping: $.
    - path: /vouchers/purchases
      name: createvoucherpurchase
      operations:
      - method: POST
        name: createvoucherpurchase
        description: Zendit Create Voucher Purchase
        call: zendit.createvoucherpurchase
        outputParameters:
        - type: object
          mapping: $.
    - path: /vouchers/purchases/{transactionId}
      name: getvoucherpurchase
      operations:
      - method: GET
        name: getvoucherpurchase
        description: Zendit Get Voucher Purchase
        call: zendit.getvoucherpurchase
        outputParameters:
        - type: object
          mapping: $.
    - path: /transactions
      name: listtransactions
      operations:
      - method: GET
        name: listtransactions
        description: Zendit List Transactions
        call: zendit.listtransactions
        outputParameters:
        - type: object
          mapping: $.
    - path: /transactions/{transactionId}
      name: gettransaction
      operations:
      - method: GET
        name: gettransaction
        description: Zendit Get Transaction
        call: zendit.gettransaction
        outputParameters:
        - type: object
          mapping: $.
    - path: /tools/phonenumberlookup/{msisdn}
      name: lookupphonenumber
      operations:
      - method: GET
        name: lookupphonenumber
        description: Zendit Lookup Phone Number
        call: zendit.lookupphonenumber
        with:
          msisdn: rest.msisdn
        outputParameters:
        - type: object
          mapping: $.
    - path: /reports
      name: createreport
      operations:
      - method: POST
        name: createreport
        description: Zendit Create Report
        call: zendit.createreport
        outputParameters:
        - type: object
          mapping: $.
    - path: /reports/{reportId}
      name: getreport
      operations:
      - method: GET
        name: getreport
        description: Zendit Get Report
        call: zendit.getreport
        with:
          reportId: rest.reportId
        outputParameters:
        - type: object
          mapping: $.
    - path: /reports/{reportId}/download
      name: downloadreport
      operations:
      - method: GET
        name: downloadreport
        description: Zendit Download Report
        call: zendit.downloadreport
        with:
          reportId: rest.reportId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    port: 9090
    namespace: zendit-mcp
    transport: http
    description: MCP adapter for Zendit API for AI agent use.
    tools:
    - name: getbalance
      description: Zendit Get Balance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getbalance
      outputParameters:
      - type: object
        mapping: $.
    - name: listbrands
      description: Zendit List Brands
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listbrands
      outputParameters:
      - type: object
        mapping: $.
    - name: getbrand
      description: Zendit Get Brand
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getbrand
      with:
        brand: tools.brand
      inputParameters:
      - name: brand
        type: string
        description: brand
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getbrandredemptioninstructions
      description: Zendit Get Brand Redemption Instructions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getbrandredemptioninstructions
      with:
        brand: tools.brand
      inputParameters:
      - name: brand
        type: string
        description: brand
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: listtopupoffers
      description: Zendit List Topup Offers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listtopupoffers
      with:
        brand: tools.brand
        subType: tools.subType
      inputParameters:
      - name: brand
        type: string
        description: brand
      - name: subType
        type: string
        description: subType
      outputParameters:
      - type: object
        mapping: $.
    - name: gettopupoffer
      description: Zendit Get Topup Offer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.gettopupoffer
      outputParameters:
      - type: object
        mapping: $.
    - name: listtopuppurchases
      description: Zendit List Topup Purchases
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listtopuppurchases
      outputParameters:
      - type: object
        mapping: $.
    - name: createtopuppurchase
      description: Zendit Create Topup Purchase
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zendit.createtopuppurchase
      outputParameters:
      - type: object
        mapping: $.
    - name: gettopuppurchase
      description: Zendit Get Topup Purchase
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.gettopuppurchase
      outputParameters:
      - type: object
        mapping: $.
    - name: listesimoffers
      description: Zendit List ESIM Offers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listesimoffers
      with:
        regions: tools.regions
      inputParameters:
      - name: regions
        type: string
        description: regions
      outputParameters:
      - type: object
        mapping: $.
    - name: getesimoffer
      description: Zendit Get ESIM Offer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getesimoffer
      outputParameters:
      - type: object
        mapping: $.
    - name: listesimpurchases
      description: Zendit List ESIM Purchases
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listesimpurchases
      outputParameters:
      - type: object
        mapping: $.
    - name: createesimpurchase
      description: Zendit Create ESIM Purchase
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zendit.createesimpurchase
      outputParameters:
      - type: object
        mapping: $.
    - name: getesimpurchase
      description: Zendit Get ESIM Purchase
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getesimpurchase
      outputParameters:
      - type: object
        mapping: $.
    - name: getesimqrcode
      description: Zendit Get ESIM QR Code
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getesimqrcode
      outputParameters:
      - type: object
        mapping: $.
    - name: getesimplans
      description: Zendit Get ESIM Plans
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getesimplans
      with:
        iccId: tools.iccId
      inputParameters:
      - name: iccId
        type: string
        description: iccId
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: getesimrefund
      description: Zendit Get ESIM Refund
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getesimrefund
      outputParameters:
      - type: object
        mapping: $.
    - name: createesimrefund
      description: Zendit Create ESIM Refund
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zendit.createesimrefund
      outputParameters:
      - type: object
        mapping: $.
    - name: listvoucheroffers
      description: Zendit List Voucher Offers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listvoucheroffers
      outputParameters:
      - type: object
        mapping: $.
    - name: getvoucheroffer
      description: Zendit Get Voucher Offer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getvoucheroffer
      outputParameters:
      - type: object
        mapping: $.
    - name: listvoucherpurchases
      description: Zendit List Voucher Purchases
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listvoucherpurchases
      outputParameters:
      - type: object
        mapping: $.
    - name: createvoucherpurchase
      description: Zendit Create Voucher Purchase
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zendit.createvoucherpurchase
      outputParameters:
      - type: object
        mapping: $.
    - name: getvoucherpurchase
      description: Zendit Get Voucher Purchase
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getvoucherpurchase
      outputParameters:
      - type: object
        mapping: $.
    - name: listtransactions
      description: Zendit List Transactions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.listtransactions
      outputParameters:
      - type: object
        mapping: $.
    - name: gettransaction
      description: Zendit Get Transaction
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.gettransaction
      outputParameters:
      - type: object
        mapping: $.
    - name: lookupphonenumber
      description: Zendit Lookup Phone Number
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.lookupphonenumber
      with:
        msisdn: tools.msisdn
      inputParameters:
      - name: msisdn
        type: string
        description: msisdn
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: createreport
      description: Zendit Create Report
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zendit.createreport
      outputParameters:
      - type: object
        mapping: $.
    - name: getreport
      description: Zendit Get Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.getreport
      with:
        reportId: tools.reportId
      inputParameters:
      - name: reportId
        type: string
        description: reportId
        required: true
      outputParameters:
      - type: object
        mapping: $.
    - name: downloadreport
      description: Zendit Download Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zendit.downloadreport
      with:
        reportId: tools.reportId
      inputParameters:
      - name: reportId
        type: string
        description: reportId
        required: true
      outputParameters:
      - type: object
        mapping: $.
binds:
- namespace: env
  keys:
    ZENDIT_TOKEN: ZENDIT_TOKEN