​
Resources API

The Resources API provides information about payment channels, countries, currencies, and banks supported by Notch Pay. Use these endpoints to get up-to-date information for your integration.

​
API Endpoints

List Payment Channels

GET /resources/channels
Retrieve a list of available payment channels.

​
Query Parameters

​
country
string
Filter channels by country code (e.g., CM, NG)
​
currency
string
Filter channels by currency code (e.g., XAF, NGN)
​
type
string
Filter by channel type: mobile_money, bank, ussd, qr

Get Channel Details

GET /resources/channels/{id}
Retrieve details of a specific payment channel.

​
Path Parameters

​
id
string
required
ID of the channel to retrieve (e.g., cm.mtn, ng.card)

List Countries

GET /resources/countries
Retrieve a list of supported countries.

Get Country Details

GET /resources/countries/{code}
Retrieve details of a specific country.

​
Path Parameters

​
code
string
required
Two-letter ISO country code (e.g., CM, NG)

List Currencies

GET /resources/currencies
Retrieve a list of supported currencies.

Get Currency Details

GET /resources/currencies/{code}
Retrieve details of a specific currency.

​
Path Parameters

​
code
string
required
Three-letter ISO currency code (e.g., XAF, NGN, USD)

List Banks

GET /resources/banks
Retrieve a list of supported banks.

​
Query Parameters

​
country
string
Filter banks by country code (e.g., CM, NG)

Get Bank Details

GET /resources/banks/{code}
Retrieve details of a specific bank.

​
Path Parameters

​
code
string
required
Bank code (e.g., SGCM, GTB)

​
Channel Types

mobile_money

Mobile money payment channels like MTN Mobile Money, Orange Money, etc.

bank

Bank transfer payment channels

ussd

USSD-based payment channels

qr

QR code-based payment channels

wallet

Digital wallet payment channels

​
Best Practices

Cache Resource Data

Cache resource data like countries, currencies, and banks to reduce API calls.Refresh your cache periodically (e.g., daily) to ensure you have the latest information.

Dynamic Channel Selection

Use the channels endpoint to dynamically populate payment method options in your checkout.Filter channels based on the customer’s country and currency for a better user experience.

Validate Input Data

Use the resources API to validate input data like country codes, currency codes, and bank codes.This helps prevent errors when creating payments or transfers.

Check Limits

Check the minimum and maximum amounts for each payment channel to ensure your payment requests are within the allowed limits.Display appropriate error messages to users when amounts are outside these limits.

​
Supported African Countries

Notch Pay is designed specifically for the African market, with support for multiple countries across the continent. Here’s an overview of our current coverage:
Nigeria Flag

Nigeria

Currency: NGN (₦)

Bank TransfersCardsUSSD
Ghana Flag

Ghana

Currency: GHS (₵)

Mobile MoneyCards
Côte d'Ivoire Flag

Côte d’Ivoire

Currency: XOF (CFA)

Mobile MoneyCards
Senegal Flag

Senegal

Currency: XOF (CFA)

Mobile MoneyWave

Payments API

Create and manage payments using the available channels

Transfers API

Send money to beneficiaries using the available banks

Beneficiaries API

Create and manage beneficiaries with bank information