Channels
This endpoint retrieves a list of channels.
Responses
- 200
OK
- 401
Unauthorized
GET/channels
Shell cURL
curl --request GET \
--url https://api.notchpay.co/channels{
"code": 200,
"status": "OK",
"message": "Channels retrieved",
"data": [
{
"name": "Mobile Money",
"desc": "Pay with MTN MoMo or Orange Money",
"active": true,
"id": "cm.mobile",
"enabled": true,
"e2e": true,
"collect": true
},
{
"name": "Card",
"desc": "The quickest and easiest way to Pay",
"active": true,
"id": "card",
"enabled": false,
"e2e": true,
"collect": true
},
{
"name": "PayPal",
"desc": "Most popular online wallet in the world",
"active": true,
"id": "paypal",
"enabled": true,
"e2e": false,
"collect": true
},
{
"name": "MTN Mobile Money",
"desc": "Pay with MTN MoMo",
"active": true,
"id": "cm.mtn",
"enabled": true,
"e2e": true,
"collect": true
},
{
"name": "Orange Money",
"desc": "Pay with Orange Money",
"active": true,
"id": "cm.orange",
"enabled": true,
"e2e": true,
"collect": true
}
]
}OK
Currencies
This endpoint retrieves a list of currencies.
Responses
- 200
OK
- 401
Unauthorized
GET/currencies
Shell cURL
curl --request GET \
--url https://api.notchpay.co/currencies{
"code": 200,
"status": "OK",
"message": "Currencies retrieved",
"data": [
{
"name": "Afghanistan, Afghani",
"code": "AFN",
"fraction": 2,
"symbol": "؋"
},
{
"name": "Albania, Lek",
"code": "ALL",
"fraction": 2,
"symbol": "Lek"
},
{
"name": "Algerian Dinar",
"code": "DZD",
"fraction": 2,
"symbol": "د.ج"
},
{
"name": "Angola, Kwanza",
"code": "AOA",
"fraction": 2,
"symbol": "Kz"
},
{
"name": "Argentine Peso",
"code": "ARS",
"fraction": 2,
"symbol": "$"
},
{
"name": "Armenian Dram",
"code": "AMD",
"fraction": 2,
"symbol": "֏"
},
{
"name": "Aruban Guilder",
"code": "AWG",
"fraction": 2,
"symbol": "ƒ"
},
{
"name": "Australian Dollar",
"code": "AUD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Azerbaijanian Manat",
"code": "AZN",
"fraction": 2,
"symbol": "₼"
},
{
"name": "Bahamian Dollar",
"code": "BSD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Bahraini Dinar",
"code": "BHD",
"fraction": 3,
"symbol": ".د."
},
{
"name": "Bangladesh, Taka",
"code": "BDT",
"fraction": 2,
"symbol": "৳"
},
{
"name": "Barbados Dollar",
"code": "BBD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Belarussian Ruble",
"code": "BYN",
"fraction": 2,
"symbol": "р."
},
{
"name": "Belize Dollar",
"code": "BZD",
"fraction": 2,
"symbol": "BZ$"
},
{
"name": "Bermudian Dollar",
"code": "BMD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Bhutan, Ngultrum",
"code": "BTN",
"fraction": 2,
"symbol": "Nu."
},
{
"name": "Bolivia, Boliviano",
"code": "BOB",
"fraction": 2,
"symbol": "Bs"
},
{
"name": "Bosnia and Herzegovina, Convertible Marks",
"code": "BAM",
"fraction": 2,
"symbol": "КМ"
},
{
"name": "Botswana, Pula",
"code": "BWP",
"fraction": 2,
"symbol": "P"
},
{
"name": "Brazilian Real",
"code": "BRL",
"fraction": 2,
"symbol": "R$"
},
{
"name": "Brunei Dollar",
"code": "BND",
"fraction": 2,
"symbol": "$"
},
{
"name": "Bulgarian Lev",
"code": "BGN",
"fraction": 2,
"symbol": "лв."
},
{
"name": "Burundi Franc",
"code": "BIF",
"fraction": 0,
"symbol": "FBu"
},
{
"name": "Cambodia, Riel",
"code": "KHR",
"fraction": 2,
"symbol": "៛"
},
{
"name": "Canadian Dollar",
"code": "CAD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Cape Verde Escudo",
"code": "CVE",
"fraction": 2,
"symbol": "$"
},
{
"name": "Cayman Islands Dollar",
"code": "KYD",
"fraction": 2,
"symbol": "$"
},
{
"name": "CFP Franc",
"code": "XPF",
"fraction": 0,
"symbol": "F"
},
{
"name": "Chilean Peso",
"code": "CLP",
"fraction": 0,
"symbol": "$"
},
{
"name": "China Yuan Renminbi",
"code": "CNY",
"fraction": 2,
"symbol": "¥"
},
{
"name": "Colombian Peso",
"code": "COP",
"fraction": 0,
"symbol": "$"
},
{
"name": "Comoro Franc",
"code": "KMF",
"fraction": 0,
"symbol": "CF"
},
{
"name": "Costa Rican Colon",
"code": "CRC",
"fraction": 2,
"symbol": "₡"
},
{
"name": "Croatian Kuna",
"code": "HRK",
"fraction": 2,
"symbol": "kn"
},
{
"name": "Cuban Convertible Peso",
"code": "CUC",
"fraction": 2,
"symbol": "CUC"
},
{
"name": "Cuban Peso",
"code": "CUP",
"fraction": 2,
"symbol": "$MN"
},
{
"name": "Czech Koruna",
"code": "CZK",
"fraction": 2,
"symbol": "Kč"
},
{
"name": "Danish Krone",
"code": "DKK",
"fraction": 2,
"symbol": "kr."
},
{
"name": "Djibouti Franc",
"code": "DJF",
"fraction": 0,
"symbol": "Fdj"
},
{
"name": "Dominican Peso",
"code": "DOP",
"fraction": 2,
"symbol": "RD$"
},
{
"name": "East Caribbean Dollar",
"code": "XCD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Egyptian Pound",
"code": "EGP",
"fraction": 2,
"symbol": "ج.م"
},
{
"name": "El Salvador Colon",
"code": "SVC",
"fraction": 2,
"symbol": "₡"
},
{
"name": "Eritrea, Nakfa",
"code": "ERN",
"fraction": 2,
"symbol": "Nfk"
},
{
"name": "Ethiopian Birr",
"code": "ETB",
"fraction": 2,
"symbol": "ETB"
},
{
"name": "Euro",
"code": "EUR",
"fraction": 2,
"symbol": "€"
},
{
"name": "Falkland Islands Pound",
"code": "FKP",
"fraction": 2,
"symbol": "£"
},
{
"name": "Fiji Dollar",
"code": "FJD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Franc CFA (XAF)",
"code": "XAF",
"fraction": 0,
"symbol": "F.CFA"
},
{
"name": "Franc CFA (XOF)",
"code": "XOF",
"fraction": 0,
"symbol": "F.CFA"
},
{
"name": "Franc Congolais",
"code": "CDF",
"fraction": 2,
"symbol": "FC"
},
{
"name": "Gambia, Dalasi",
"code": "GMD",
"fraction": 2,
"symbol": "D"
},
{
"name": "Georgia, Lari",
"code": "GEL",
"fraction": 2,
"symbol": "Lari"
},
{
"name": "Ghana Cedi",
"code": "GHS",
"fraction": 2,
"symbol": "₵"
},
{
"name": "Gibraltar Pound",
"code": "GIP",
"fraction": 2,
"symbol": "£"
},
{
"name": "Guatemala, Quetzal",
"code": "GTQ",
"fraction": 2,
"symbol": "Q"
},
{
"name": "Guinean franc",
"code": "GNF",
"fraction": 0,
"symbol": "FG"
},
{
"name": "Guyana Dollar",
"code": "GYD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Haiti, Gourde",
"code": "HTG",
"fraction": 2,
"symbol": "G"
},
{
"name": "Honduras, Lempira",
"code": "HNL",
"fraction": 2,
"symbol": "L."
},
{
"name": "Hong Kong Dollar",
"code": "HKD",
"fraction": 2,
"symbol": "HK$"
},
{
"name": "Hungary, Forint",
"code": "HUF",
"fraction": 0,
"symbol": "Ft"
},
{
"name": "Iceland Krona",
"code": "ISK",
"fraction": 2,
"symbol": "kr."
},
{
"name": "Indian Rupee",
"code": "INR",
"fraction": 2,
"symbol": "₹"
},
{
"name": "Indonesia, Rupiah",
"code": "IDR",
"fraction": 2,
"symbol": "Rp"
},
{
"name": "Iranian Rial",
"code": "IRR",
"fraction": 0,
"symbol": "﷼"
},
{
"name": "Iraqi Dinar",
"code": "IQD",
"fraction": 3,
"symbol": "د.ع."
},
{
"name": "Jamaican Dollar",
"code": "JMD",
"fraction": 2,
"symbol": "J$"
},
{
"name": "Japan, Yen",
"code": "JPY",
"fraction": 0,
"symbol": "¥"
},
{
"name": "Jordanian Dinar",
"code": "JOD",
"fraction": 3,
"symbol": "د.ا."
},
{
"name": "Kazakhstan, Tenge",
"code": "KZT",
"fraction": 2,
"symbol": "₸"
},
{
"name": "Kenyan Shilling",
"code": "KES",
"fraction": 2,
"symbol": "S"
},
{
"name": "Kuwaiti Dinar",
"code": "KWD",
"fraction": 3,
"symbol": "دينار"
},
{
"name": "Kyrgyzstan, Som",
"code": "KGS",
"fraction": 2,
"symbol": "сом"
},
{
"name": "Laos, Kip",
"code": "LAK",
"fraction": 2,
"symbol": "₭"
},
{
"name": "Lebanese Pound",
"code": "LBP",
"fraction": 2,
"symbol": "ل.ل."
},
{
"name": "Lesotho, Loti",
"code": "LSL",
"fraction": 2,
"symbol": "M"
},
{
"name": "Liberian Dollar",
"code": "LRD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Libyan Dinar",
"code": "LYD",
"fraction": 3,
"symbol": "د.ل."
},
{
"name": "Macao, Pataca",
"code": "MOP",
"fraction": 2,
"symbol": "MOP$"
},
{
"name": "Macedonia, Denar",
"code": "MKD",
"fraction": 2,
"symbol": "ден."
},
{
"name": "Malagasy Ariary",
"code": "MGA",
"fraction": 1,
"symbol": "Ar"
},
{
"name": "Malawi, Kwacha",
"code": "MWK",
"fraction": 2,
"symbol": "MK"
},
{
"name": "Malaysian Ringgit",
"code": "MYR",
"fraction": 2,
"symbol": "RM"
},
{
"name": "Maldives, Rufiyaa",
"code": "MVR",
"fraction": 2,
"symbol": "MVR"
},
{
"name": "Maltese Lira",
"code": "MTL",
"fraction": 0,
"symbol": "₤"
},
{
"name": "Mauritania, Ouguiya",
"code": "MRU",
"fraction": 0,
"symbol": "UM"
},
{
"name": "Mauritius Rupee",
"code": "MUR",
"fraction": 2,
"symbol": "₨"
},
{
"name": "Mexican Peso",
"code": "MXN",
"fraction": 2,
"symbol": "$"
},
{
"name": "Moldovan Leu",
"code": "MDL",
"fraction": 2,
"symbol": "lei"
},
{
"name": "Mongolia, Tugrik",
"code": "MNT",
"fraction": 2,
"symbol": "₮"
},
{
"name": "Moroccan Dirham",
"code": "MAD",
"fraction": 2,
"symbol": "د.م."
},
{
"name": "Mozambique Metical",
"code": "MZN",
"fraction": 2,
"symbol": "MT"
},
{
"name": "Myanmar, Kyat",
"code": "MMK",
"fraction": 2,
"symbol": "K"
},
{
"name": "Namibian Dollar",
"code": "NAD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Nepalese Rupee",
"code": "NPR",
"fraction": 2,
"symbol": "₨"
},
{
"name": "Netherlands Antillian Guilder",
"code": "ANG",
"fraction": 2,
"symbol": "ƒ"
},
{
"name": "New Israeli Shekel",
"code": "ILS",
"fraction": 2,
"symbol": "₪"
},
{
"name": "New Taiwan Dollar",
"code": "TWD",
"fraction": 0,
"symbol": "NT$"
},
{
"name": "New Zealand Dollar",
"code": "NZD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Nicaragua, Cordoba Oro",
"code": "NIO",
"fraction": 2,
"symbol": "C$"
},
{
"name": "Nigeria, Naira",
"code": "NGN",
"fraction": 2,
"symbol": "₦"
},
{
"name": "North Korean Won",
"code": "KPW",
"fraction": 0,
"symbol": "₩"
},
{
"name": "Norwegian Krone",
"code": "NOK",
"fraction": 2,
"symbol": "kr"
},
{
"name": "Pakistan Rupee",
"code": "PKR",
"fraction": 2,
"symbol": "₨"
},
{
"name": "Panama, Balboa",
"code": "PAB",
"fraction": 2,
"symbol": "B/."
},
{
"name": "Papua New Guinea, Kina",
"code": "PGK",
"fraction": 2,
"symbol": "K"
},
{
"name": "Paraguay, Guarani",
"code": "PYG",
"fraction": 0,
"symbol": "₲"
},
{
"name": "Peru, Nuevo Sol",
"code": "PEN",
"fraction": 2,
"symbol": "S/."
},
{
"name": "Peso Uruguayo",
"code": "UYU",
"fraction": 0,
"symbol": "$U"
},
{
"name": "Philippine Peso",
"code": "PHP",
"fraction": 2,
"symbol": "₱"
},
{
"name": "Poland, Zloty",
"code": "PLN",
"fraction": 2,
"symbol": "zł"
},
{
"name": "Pound Sterling",
"code": "GBP",
"fraction": 2,
"symbol": "£"
},
{
"name": "Qatari Rial",
"code": "QAR",
"fraction": 2,
"symbol": "﷼"
},
{
"name": "Rial Omani",
"code": "OMR",
"fraction": 3,
"symbol": "﷼"
},
{
"name": "Romania, New Leu",
"code": "RON",
"fraction": 2,
"symbol": "lei"
},
{
"name": "Russian Ruble",
"code": "RUB",
"fraction": 2,
"symbol": "₽"
},
{
"name": "Rwanda Franc",
"code": "RWF",
"fraction": 0,
"symbol": "RWF"
},
{
"name": "Saint Helena Pound",
"code": "SHP",
"fraction": 2,
"symbol": "£"
},
{
"name": "Samoa, Tala",
"code": "WST",
"fraction": 2,
"symbol": "WS$"
},
{
"name": "Sao Tome and Principe, Dobra",
"code": "STN",
"fraction": 0,
"symbol": "Db"
},
{
"name": "Saudi Riyal",
"code": "SAR",
"fraction": 2,
"symbol": "﷼"
},
{
"name": "Serbian Dinar",
"code": "RSD",
"fraction": 2,
"symbol": "Дин."
},
{
"name": "Seychelles Rupee",
"code": "SCR",
"fraction": 2,
"symbol": "₨"
},
{
"name": "Sierra Leone, Leone",
"code": "SLL",
"fraction": 2,
"symbol": "Le"
},
{
"name": "Singapore Dollar",
"code": "SGD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Solomon Islands Dollar",
"code": "SBD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Somali Shilling",
"code": "SOS",
"fraction": 2,
"symbol": "S"
},
{
"name": "South Africa, Rand",
"code": "ZAR",
"fraction": 2,
"symbol": "R"
},
{
"name": "South Korea, Won",
"code": "KRW",
"fraction": 0,
"symbol": "₩"
},
{
"name": "South Sudanese pound",
"code": "SSP",
"fraction": 2,
"symbol": "SS£"
},
{
"name": "Sri Lanka Rupee",
"code": "LKR",
"fraction": 2,
"symbol": "₨"
},
{
"name": "Sudanese Pound",
"code": "SDG",
"fraction": 2,
"symbol": "ج.س"
},
{
"name": "Surinam Dollar",
"code": "SRD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Swaziland, Lilangeni",
"code": "SZL",
"fraction": 2,
"symbol": "E"
},
{
"name": "Swedish Krona",
"code": "SEK",
"fraction": 2,
"symbol": "kr"
},
{
"name": "Swiss Franc",
"code": "CHF",
"fraction": 2,
"symbol": "CHF"
},
{
"name": "Syrian Pound",
"code": "SYP",
"fraction": 2,
"symbol": "£"
},
{
"name": "Tajikistan, Somoni",
"code": "TJS",
"fraction": 2,
"symbol": "TJS"
},
{
"name": "Tanzanian Shilling",
"code": "TZS",
"fraction": 0,
"symbol": "TSh"
},
{
"name": "Thailand, Baht",
"code": "THB",
"fraction": 2,
"symbol": "฿"
},
{
"name": "Tonga, Paanga",
"code": "TOP",
"fraction": 2,
"symbol": "T$"
},
{
"name": "Trinidad and Tobago Dollar",
"code": "TTD",
"fraction": 2,
"symbol": "TT$"
},
{
"name": "Tunisian Dinar",
"code": "TND",
"fraction": 3,
"symbol": "د.ت."
},
{
"name": "Turkish Lira",
"code": "TRY",
"fraction": 2,
"symbol": "TL"
},
{
"name": "Turkmenistani New Manat",
"code": "TMT",
"fraction": 2,
"symbol": "m"
},
{
"name": "UAE Dirham",
"code": "AED",
"fraction": 2,
"symbol": "دإ"
},
{
"name": "Uganda Shilling",
"code": "UGX",
"fraction": 0,
"symbol": "USh"
},
{
"name": "Ukraine, Hryvnia",
"code": "UAH",
"fraction": 2,
"symbol": "₴"
},
{
"name": "US Dollar",
"code": "USD",
"fraction": 2,
"symbol": "$"
},
{
"name": "Uzbekistan Sum",
"code": "UZS",
"fraction": 2,
"symbol": "сўм"
},
{
"name": "Vanuatu, Vatu",
"code": "VUV",
"fraction": 0,
"symbol": "VT"
},
{
"name": "Venezuela Bolivares soberano",
"code": "VES",
"fraction": 2,
"symbol": "Bs. S."
},
{
"name": "Viet Nam, Dong",
"code": "VND",
"fraction": 0,
"symbol": "₫"
},
{
"name": "Yemeni Rial",
"code": "YER",
"fraction": 2,
"symbol": "﷼"
},
{
"name": "Zambia Kwacha",
"code": "ZMW",
"fraction": 2,
"symbol": "ZK"
},
{
"name": "Zimbabwean dollar",
"code": "ZWL",
"fraction": 2,
"symbol": "$"
}
]
}OK
2.0.0
OAS 3.1.0
API Reference
The Notch Pay API is designed to provide you with a simple and powerful integration with our payment platform. Here are the fundamental principles that guide our API:
RESTful Architecture
Our API is built on the REST (Representational State Transfer) architecture, providing you with intuitive and predictable URLs for interacting with Notch Pay resources (payments, customers, transactions, etc.).
Request and Response Format
Requests: Requests are sent in the application/json format for maximum compatibility. Responses: All responses are returned in JSON format, clearly structured for easy processing in your application.
Standard HTTP Response Codes
We use standard HTTP response codes to indicate the success or failure of requests, providing you with accurate information about the outcome of each interaction.
Secure Authentication
Authentication is ensured through unique API keys that you obtain when you sign up. These keys ensure that only authorized applications can access your Notch Pay account.
Test Mode
Our API offers a comprehensive test mode that allows you to develop and test your integration without affecting your live data or interacting with banking networks.
Continuous Evolution
We regularly update our API with new features and improvements. Check our documentation regularly to stay informed about the latest developments.
Individual Resources
Our API handles resources individually. Each request should focus on a single resource at a time to ensure the consistency and reliability of operations.
Ready to get started? Explore our detailed integration guides and comprehensive API references to start accepting payments seamlessly with Notch Pay.
Additional Key Points to Consider for Your Notch Pay Documentation:
Code Examples: Provide concrete code examples in different languages to help developers quickly integrate the API.
Support Channels: Clearly indicate how developers can get help if needed (email, forum, etc.).
Base URL
Client Libraries
Shell
Ruby
Node.js
PHP
Python
More
cURL Shell
Resources
Channels
This endpoint retrieves a list of channels.
Responses
- 200
OK
- 401
Unauthorized
GET/channels
Shell cURL
curl --request GET \
--url https://api.notchpay.co/channels{
"code": 200,
"status": "OK",
"message": "Channels retrieved",
"data": [
{
"name": "Mobile Money",
"desc": "Pay with MTN MoMo or Orange Money",
"active": true,
"id": "cm.mobile",
"enabled": true,
"e2e": true,
"collect": true
},
{
"name": "Card",
"desc": "The quickest and easiest way to Pay",
"active": true,
"id": "card",
"enabled": false,
"e2e": true,
"collect": true
},
{
"name": "PayPal",
"desc": "Most popular online wallet in the world",
"active": true,
"id": "paypal",
"enabled": true,
"e2e": false,
"collect": true
},
{
"name": "MTN Mobile Money",
"desc": "Pay with MTN MoMo",
"active": true,
"id": "cm.mtn",
"enabled": true,
"e2e": true,
"collect": true
},
{
"name": "Orange Money",
"desc": "Pay with Orange Money",
"active": true,
"id": "cm.orange",
"enabled": true,
"e2e": true,
"collect": true
}
]
}OK