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 Retrieve a list of available payment channels. Query Parameters Filter channels by country code (e.g., CM, NG)
Filter channels by currency code (e.g., XAF, NGN)
Filter by channel type: mobile_money, bank, ussd, qr
{ "code" : 200 , "status" : "OK" , "message" : "Channels retrieved" , "channels" : [ { "id" : "cm.mtn" , "name" : "MTN Mobile Money" , "country" : "CM" , "currency" : "XAF" , "type" : "mobile_money" , "logo" : "https://assets.notchpay.co/channels/mtn.png" , "minimum" : 100 , "maximum" : 5000000 }, { "id" : "cm.orange" , "name" : "Orange Money" , "country" : "CM" , "currency" : "XAF" , "type" : "mobile_money" , "logo" : "https://assets.notchpay.co/channels/orange.png" , "minimum" : 100 , "maximum" : 5000000 }, // More channels... ] }
Get Channel Details GET /resources/channels/{id}
Retrieve details of a specific payment channel. Path Parameters ID of the channel to retrieve (e.g., cm.mtn, ng.card)
{ "code" : 200 , "status" : "OK" , "message" : "Channel retrieved" , "channel" : { "id" : "cm.mtn" , "name" : "MTN Mobile Money" , "country" : "CM" , "currency" : "XAF" , "type" : "mobile_money" , "logo" : "https://assets.notchpay.co/channels/mtn.png" , "minimum" : 100 , "maximum" : 5000000 , "processing_time" : "instant" , "requires_phone" : true , "requires_otp" : true , "description" : "Pay with MTN Mobile Money in Cameroon" , "instructions" : "You will receive a prompt on your phone to confirm the payment." } }
List Countries Retrieve a list of supported countries. { "code" : 200 , "status" : "OK" , "message" : "Countries retrieved" , "countries" : [ { "code" : "CM" , "name" : "Cameroon" , "currency" : "XAF" , "flag" : "https://assets.notchpay.co/flags/cm.png" , "phone_code" : "+237" , "channels" : [ "mobile_money" , "card" , "bank" ] }, { "code" : "NG" , "name" : "Nigeria" , "currency" : "NGN" , "flag" : "https://assets.notchpay.co/flags/ng.png" , "phone_code" : "+234" , "channels" : [ "mobile_money" , "card" , "bank" , "ussd" ] }, // More countries... ] }
Get Country Details GET /resources/countries/{code}
Retrieve details of a specific country. Path Parameters Two-letter ISO country code (e.g., CM, NG)
{ "code" : 200 , "status" : "OK" , "message" : "Country retrieved" , "country" : { "code" : "CM" , "name" : "Cameroon" , "currency" : "XAF" , "flag" : "https://assets.notchpay.co/flags/cm.png" , "phone_code" : "+237" , "channels" : [ "mobile_money" , "card" , "bank" ], "available_channels" : [ { "id" : "cm.mtn" , "name" : "MTN Mobile Money" , "type" : "mobile_money" }, { "id" : "cm.orange" , "name" : "Orange Money" , "type" : "mobile_money" }, { "id" : "cm.card" , "name" : "Card Payment" , "type" : "card" } ] } }
List Currencies GET /resources/currencies
Retrieve a list of supported currencies. { "code" : 200 , "status" : "OK" , "message" : "Currencies retrieved" , "currencies" : [ { "code" : "XAF" , "name" : "Central African CFA Franc" , "symbol" : "FCFA" , "countries" : [ "CM" , "GA" , "TD" , "CG" , "CF" , "GQ" ], "minimum_amount" : 100 , "maximum_amount" : 50000000 }, { "code" : "NGN" , "name" : "Nigerian Naira" , "symbol" : "₦" , "countries" : [ "NG" ], "minimum_amount" : 100 , "maximum_amount" : 10000000 }, { "code" : "USD" , "name" : "United States Dollar" , "symbol" : "$" , "countries" : [], "minimum_amount" : 1 , "maximum_amount" : 100000 }, // More currencies... ] }
Get Currency Details GET /resources/currencies/{code}
Retrieve details of a specific currency. Path Parameters Three-letter ISO currency code (e.g., XAF, NGN, USD)
{ "code" : 200 , "status" : "OK" , "message" : "Currency retrieved" , "currency" : { "code" : "XAF" , "name" : "Central African CFA Franc" , "symbol" : "FCFA" , "countries" : [ "CM" , "GA" , "TD" , "CG" , "CF" , "GQ" ], "minimum_amount" : 100 , "maximum_amount" : 50000000 , "decimal_places" : 0 , "exchange_rates" : { "USD" : 0.00165 , "EUR" : 0.00152 , "NGN" : 2.5 } } }
List Banks Retrieve a list of supported banks. Query Parameters Filter banks by country code (e.g., CM, NG)
{ "code" : 200 , "status" : "OK" , "message" : "Banks retrieved" , "banks" : [ { "code" : "SGCM" , "name" : "Société Générale Cameroun" , "country" : "CM" , "logo" : "https://assets.notchpay.co/banks/sgcm.png" }, { "code" : "BICEC" , "name" : "Banque Internationale du Cameroun pour l'Epargne et le Crédit" , "country" : "CM" , "logo" : "https://assets.notchpay.co/banks/bicec.png" }, { "code" : "GTB" , "name" : "Guaranty Trust Bank" , "country" : "NG" , "logo" : "https://assets.notchpay.co/banks/gtb.png" }, // More banks... ] }
Get Bank Details GET /resources/banks/{code}
Retrieve details of a specific bank. Path Parameters Bank code (e.g., SGCM, GTB)
{ "code" : 200 , "status" : "OK" , "message" : "Bank retrieved" , "bank" : { "code" : "SGCM" , "name" : "Société Générale Cameroun" , "country" : "CM" , "logo" : "https://assets.notchpay.co/banks/sgcm.png" , "swift_code" : "SGCMCMCX" , "branch_codes" : [ "001" , "002" , "003" ], "account_format" : "^[0-9]{11}$" , "account_validation" : "regex" , "transfer_enabled" : true , "transfer_processing_time" : "1-2 business days" } }
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:
West Africa
Central Africa
East Africa
Nigeria Currency: NGN (₦)
Bank Transfers Cards USSD
Ghana Currency: GHS (₵)
Mobile Money Cards
Côte d’Ivoire Currency: XOF (CFA)
Mobile Money Cards
Senegal Currency: XOF (CFA)
Mobile Money Wave
Cameroon Currency: XAF (FCFA)
MTN Mobile Money Orange Money Cards
Gabon Currency: XAF (FCFA)
Mobile Money Cards
Kenya Currency: KES (KSh)
M-Pesa Cards
Uganda Currency: UGX (USh)
Mobile Money Cards
Our coverage is continuously expanding. For the most up-to-date list of supported countries and payment methods, use the Countries API endpoint.
