naftiko: 1.0.0-alpha2
info:
  label: Interswitch Web Checkout API — Payments
  description: Hosted checkout payment initiation and server-side transaction requery.
  tags:
  - Interswitch
  - Payments
  - Webpay
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
- namespace: env
  keys:
    INTERSWITCH_CLIENT_ID: INTERSWITCH_CLIENT_ID
    INTERSWITCH_SECRET: INTERSWITCH_SECRET
    INTERSWITCH_MERCHANT_CODE: INTERSWITCH_MERCHANT_CODE
capability:
  consumes:
  - type: http
    namespace: web-checkout-payments
    baseUri: https://sandbox.interswitchng.com
    description: Interswitch Web Checkout business capability.
    resources:
    - name: gettransaction
      path: /collections/api/v1/gettransaction.json
      operations:
      - name: getTransactionStatus
        method: GET
        description: Server-side requery for an Interswitch Web Checkout transaction.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: merchantcode
          in: query
          type: string
          required: true
        - name: transactionreference
          in: query
          type: string
          required: true
        - name: amount
          in: query
          type: integer
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: 'Bearer {{env.INTERSWITCH_CLIENT_ID}}'
      placement: header
  exposes:
  - type: rest
    namespace: web-checkout-payments-rest
    port: 8080
    description: REST adapter for Interswitch Web Checkout transaction requery.
    resources:
    - path: /v1/transactions
      name: transactions
      description: REST surface for transaction status.
      operations:
      - method: GET
        name: getTransactionStatus
        description: Query an Interswitch Web Checkout transaction.
        call: web-checkout-payments.getTransactionStatus
        with:
          merchantcode: rest.query.merchantcode
          transactionreference: rest.query.transactionreference
          amount: rest.query.amount
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: web-checkout-payments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Interswitch Web Checkout.
    tools:
    - name: interswitch-get-transaction-status
      description: Server-side requery for an Interswitch Web Checkout transaction.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: web-checkout-payments.getTransactionStatus
      with:
        merchantcode: tools.merchantcode
        transactionreference: tools.transactionreference
        amount: tools.amount
      outputParameters:
      - type: object
        mapping: $.