Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Interswitch Payments API

The Payments API from Interswitch — 5 operation(s) for payments.

Interswitch Payments API is one of 32 APIs that Interswitch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, a JSON-LD context, and 1 JSON Schema.

This API exposes 5 operations across 5 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 2024-01-01.

Requests are made against 2 base URLs: https://sandbox.interswitchng.com, https://saturn.interswitchng.com.

5 operations 5 paths 2 schemas 1 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2024-01-01
Servers
https://sandbox.interswitchng.com
https://saturn.interswitchng.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Interswitch Payments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (InterswitchAuth). By default, every request must be authenticated.

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 1 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Payments 5
POST
/api/v2/quickteller/payments/advices
Submit Bill Payment Advice
submitBillPaymentAdvice body → 200
POST
/lending-service/api/v2/payments/token
Generate Lending Payment Token
generateLendingPaymentToken body → 200
POST
/lending-service/api/v2/payments/token/validate
Validate Lending Payment Token OTP
validateLendingPaymentTokenOtp body → 200
POST
/paymentgateway/api/v1/payments
Create Card Payment
createCardPayment body → 200
GET
/paymentgateway/api/v1/payments/{paymentId}
Get Payment
getPayment 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are PaymentResponse (8 properties), PaymentRequest (6 properties). Each schema is shown below with its type and property counts.

PaymentRequest
object
6 properties 4 required
PaymentResponse
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interswitch-payments-api-openapi.yml Raw ↑

Other APIs Interswitch publishes across the network.

Interswitch Transfers API
Interswitch Refunds API
Interswitch Airtime API
Interswitch Balance API
Interswitch Bank Codes API
Interswitch Billers API
Interswitch Bulk Transfers API
Interswitch Cards API
Interswitch Checkout API
Interswitch Customer Validation API
Interswitch Customers API
Interswitch Demography API