Interswitch

Interswitch Hosted Fields API

Card data tokenization

GitHub OpenAPI

Operations 1

POST /paymentgateway/api/v1/hosted-fields/sessions Create Hosted Fields Session #

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-hosted-fields-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-hosted-fields-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-hosted-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Interswitch Payment Gateway Hosted Fields API
  description: 'Server-to-server card payment APIs for PCI-DSS-licensed merchants — direct

    Card Payments, Hosted Fields tokenization, 3D Secure step-up, Google Pay,

    and Pay Bill payment-link generation. Authenticated with OAuth 2.0

    client_credentials via the Passport token service.

    '
  version: '2024-01-01'
servers:
- url: https://qa.interswitchng.com
  description: Sandbox / QA
- url: https://saturn.interswitchng.com
  description: Production
security:
- BearerAuth: []
tags:
- name: Hosted Fields
  description: Card data tokenization
paths:
  /paymentgateway/api/v1/hosted-fields/sessions:
    post:
      tags:
      - Hosted Fields
      summary: Create Hosted Fields Session
      description: Create a hosted-fields session so the browser can collect raw card data and POST it directly to Interswitch, keeping the merchant out of PCI scope.
      operationId: createHostedFieldsSession
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - transactionRef
              - amount
              - currency
              properties:
                transactionRef:
                  type: string
                amount:
                  type: integer
                currency:
                  type: string
                redirectUrl:
                  type: string
                  format: uri
      responses:
        '200':
          description: Session created.
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    type: string
                  hostedFieldsUrl:
                    type: string
                    format: uri
                  expiresAt:
                    type: string
                    format: date-time
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token from `POST {passport}/passport/oauth/token?grant_type=client_credentials`.