Interswitch

Interswitch Tokens API

The Tokens API from Interswitch — 4 operation(s) for tokens.

GitHub OpenAPI

Operations 4

POST /api/v1/pwm/subscribers/{subscriberId}/tokens Generate Paycode Token #
GET /api/v1/pwm/subscribers/{subscriberId}/tokens/status Get Token Status #
POST /cardless-service/api/v1/cardless-services/cancel-token Cancel Paycode Token #
POST /api/v1/pwm/subscribers/{subscriberId}/tokens/bulk Generate Bulk Paycode Tokens #

Documentation

📖
Documentation
https://docs.interswitchgroup.com/docs/web-checkout
📖
GettingStarted
https://docs.interswitchgroup.com/docs/quickstart
📖
Documentation
https://docs.interswitchgroup.com/docs/accept-payments
📖
Documentation
https://docs.interswitchgroup.com/docs/bills-payment
📖
Documentation
https://docs.interswitchgroup.com/docs/airtime-recharge
📖
Documentation
https://docs.interswitchgroup.com/docs/single-paycode
📖
Documentation
https://docs.interswitchgroup.com/docs/recurring-payments
📖
Documentation
https://docs.interswitchgroup.com/docs/home
📖
Documentation
https://docs.interswitchgroup.com/docs/nano-loans
📖
Documentation
https://docs.interswitchgroup.com/docs/customer-insights
📖
Documentation
https://docs.interswitchgroup.com/docs/transaction-search

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/interswitch/refs/heads/main/openapi/interswitch-tokens-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/interswitch/refs/heads/main/json-schema/interswitch-payment-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/interswitch/refs/heads/main/json-ld/interswitch-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/interswitch-tokens-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

interswitch-tokens-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Interswitch Paycode Tokens API
  description: 'Cardless cash and merchant tokens (Pay with Mobile / Paycode). Generate

    single or bulk one-time tokens, query token status, and cancel tokens.

    Powers cardless ATM withdrawal across the Interswitch-acquired ATM network.

    '
  version: '2024-01-01'
servers:
- url: https://sandbox.interswitchng.com
  description: Sandbox
- url: https://saturn.interswitchng.com
  description: Production
security:
- BearerAuth: []
tags:
- name: Tokens
paths:
  /api/v1/pwm/subscribers/{subscriberId}/tokens:
    post:
      tags:
      - Tokens
      summary: Generate Paycode Token
      description: Create a one-time access code for a cardless transaction.
      operationId: generatePaycodeToken
      parameters:
      - in: path
        name: subscriberId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - frontEndPartnerId
              - paymentMethodCode
              - amount
              - tokenLifeTimeInMinutes
              - oneTimePin
              properties:
                frontEndPartnerId:
                  type: string
                  example: WEMA
                paymentMethodCode:
                  type: string
                amount:
                  type: integer
                tokenLifeTimeInMinutes:
                  type: integer
                oneTimePin:
                  type: string
                ttid:
                  type: string
                  description: Use the same value as `transactionRef`.
                transactionRef:
                  type: string
      responses:
        '200':
          description: Token created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  payWithMobileToken:
                    type: string
                  subscriberId:
                    type: string
                  tokenLifeTimeInMinutes:
                    type: integer
                  responseCode:
                    type: string
  /api/v1/pwm/subscribers/{subscriberId}/tokens/status:
    get:
      tags:
      - Tokens
      summary: Get Token Status
      operationId: getPaycodeTokenStatus
      parameters:
      - in: path
        name: subscriberId
        required: true
        schema:
          type: string
      - in: query
        name: token
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Token status.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  channel:
                    type: string
                  surchargeAmount:
                    type: integer
                  settlementCode:
                    type: string
                  paymentMethodCode:
                    type: string
  /cardless-service/api/v1/cardless-services/cancel-token:
    post:
      tags:
      - Tokens
      summary: Cancel Paycode Token
      operationId: cancelPaycodeToken
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - referenceId
              - frontEndPartner
              properties:
                referenceId:
                  type: string
                frontEndPartner:
                  type: string
      responses:
        '200':
          description: Cancellation response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  responseCode:
                    type: string
                  responseMessage:
                    type: string
  /api/v1/pwm/subscribers/{subscriberId}/tokens/bulk:
    post:
      tags:
      - Tokens
      summary: Generate Bulk Paycode Tokens
      operationId: generateBulkPaycodeTokens
      parameters:
      - in: path
        name: subscriberId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - frontEndPartnerId
              - items
              properties:
                frontEndPartnerId:
                  type: string
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      amount:
                        type: integer
                      tokenLifeTimeInMinutes:
                        type: integer
                      referenceId:
                        type: string
      responses:
        '200':
          description: Bulk token batch.
          content:
            application/json:
              schema:
                type: object
                properties:
                  batchId:
                    type: string
                  tokens:
                    type: array
                    items:
                      type: object
                      properties:
                        referenceId:
                          type: string
                        payWithMobileToken:
                          type: string
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer