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 Refunds API

Refund successful Quickteller Business transactions in full or in part via `POST /paymentgateway/api/v1/refunds`. Tracks refund lifecycle through SUCCESS, PENDING, PROCESSING, COMPLETE, COMPLETE_MANUAL, and FAILED states; auto-refunds settle T+1.

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

Tagged areas include Refunds, Payments, Quickteller Business, and Africa. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 1 schema. 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.

2 operations 2 paths 1 schemas 1 GET1 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 Refunds 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 2

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

Refunds 2
POST
/paymentgateway/api/v1/refunds
Create Refund
createRefund body → 201400500
GET
/paymentgateway/api/v1/refunds/{refundReference}
Get Refund
getRefund 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Refund (10 properties). Each schema is shown below with its type and property counts.

Refund
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interswitch-refunds-api-openapi.yml Raw ↑

Other APIs Interswitch publishes across the network.

Interswitch Transfers 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
Interswitch Detail API