Interswitch Transfers API — Transfers

naftiko: 1.0.0-alpha2
info:
  label: Interswitch Transfers API — Transfers
  description: Single transfer, name inquiry, and bank-code resolution over the Quickteller Send Money APIs.
  tags:
  - Interswitch
  - Transfers
  - NIBSS
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
- namespace: env
  keys:
    INTERSWITCH_BEARER_TOKEN: INTERSWITCH_BEARER_TOKEN
    INTERSWITCH_TERMINAL_ID: INTERSWITCH_TERMINAL_ID
capability:
  consumes:
  - type: http
    namespace: transfers-transfers
    baseUri: https://qa.interswitchng.com
    resources:
    - name: transfer-funds
      path: /quicktellerservice/api/v5/transactions/TransferFunds
      operations:
      - name: sendSingleTransfer
        method: POST
        description: Send a single transfer to a bank account.
        outputRawFormat: json
        outputParameters:
        - { name: result, type: object, value: $. }
        inputParameters:
        - { name: body, in: body, type: object, required: true }
        - { name: terminalId, in: header, type: string, required: true }
    - name: name-inquiry
      path: /quicktellerservice/api/v5/transactions/NameInquiry
      operations:
      - name: nameInquiry
        method: POST
        description: Resolve account name for a NUBAN at a Nigerian bank.
        outputRawFormat: json
        outputParameters:
        - { name: result, type: object, value: $. }
        inputParameters:
        - { name: body, in: body, type: object, required: true }
    - name: banks
      path: /quicktellerservice/api/v5/banks
      operations:
      - name: listBanks
        method: GET
        description: List CBN bank codes addressable for transfers.
        outputRawFormat: json
        outputParameters:
        - { name: result, type: array, value: $. }
    authentication:
      type: apikey
      key: Authorization
      value: 'Bearer {{env.INTERSWITCH_BEARER_TOKEN}}'
      placement: header
  exposes:
  - type: rest
    namespace: transfers-transfers-rest
    port: 8080
    resources:
    - path: /v1/transfers
      name: transfers
      operations:
      - method: POST
        name: sendSingleTransfer
        call: transfers-transfers.sendSingleTransfer
        with:
          body: rest.body
          terminalId: rest.header.terminalId
        outputParameters:
        - { type: object, mapping: $. }
    - path: /v1/name-inquiry
      name: name-inquiry
      operations:
      - method: POST
        name: nameInquiry
        call: transfers-transfers.nameInquiry
        with:
          body: rest.body
        outputParameters:
        - { type: object, mapping: $. }
    - path: /v1/banks
      name: banks
      operations:
      - method: GET
        name: listBanks
        call: transfers-transfers.listBanks
        outputParameters:
        - { type: array, mapping: $. }
  - type: mcp
    namespace: transfers-transfers-mcp
    port: 9090
    transport: http
    tools:
    - name: interswitch-send-single-transfer
      description: Send a single transfer to a Nigerian bank account.
      hints: { readOnly: false, destructive: false, idempotent: false }
      call: transfers-transfers.sendSingleTransfer
      with:
        body: tools.body
        terminalId: tools.terminalId
      outputParameters:
      - { type: object, mapping: $. }
    - name: interswitch-name-inquiry
      description: Resolve account name for a NUBAN.
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: transfers-transfers.nameInquiry
      with:
        body: tools.body
      outputParameters:
      - { type: object, mapping: $. }
    - name: interswitch-list-banks
      description: List CBN bank codes.
      hints: { readOnly: true, destructive: false, idempotent: true }
      call: transfers-transfers.listBanks
      outputParameters:
      - { type: array, mapping: $. }