Countries
Countries
This endpoint retrieves a list of countries.
Responses
- 200
OK
- 401
Unauthorized
GET/countries
Shell cURL
curl --request GET \
--url https://api.notchpay.co/countries{
"code": 200,
"status": "OK",
"message": "Countries retrieved",
"data": [
{
"name": "Afghanistan",
"code": "AF"
},
{
"name": "Åland Islands",
"code": "AX"
},
{
"name": "Albania",
"code": "AL"
},
{
"name": "Algeria",
"code": "DZ"
},
{
"name": "American Samoa",
"code": "AS"
},
{
"name": "Andorra",
"code": "AD"
},
{
"name": "Angola",
"code": "AO"
},
{
"name": "Anguilla",
"code": "AI"
},
{
"name": "Antarctica",
"code": "AQ"
},
{
"name": "Antigua & Barbuda",
"code": "AG"
},
{
"name": "Argentina",
"code": "AR"
},
{
"name": "Armenia",
"code": "AM"
},
{
"name": "Aruba",
"code": "AW"
},
{
"name": "Australia",
"code": "AU"
},
{
"name": "Austria",
"code": "AT"
},
{
"name": "Azerbaijan",
"code": "AZ"
},
{
"name": "Bahamas",
"code": "BS"
},
{
"name": "Bahrain",
"code": "BH"
},
{
"name": "Bangladesh",
"code": "BD"
},
{
"name": "Barbados",
"code": "BB"
},
{
"name": "Belarus",
"code": "BY"
},
{
"name": "Belgium",
"code": "BE"
},
{
"name": "Belize",
"code": "BZ"
},
{
"name": "Benin",
"code": "BJ"
},
{
"name": "Bermuda",
"code": "BM"
},
{
"name": "Bhutan",
"code": "BT"
},
{
"name": "Bolivia",
"code": "BO"
},
{
"name": "Bosnia & Herzegovina",
"code": "BA"
},
{
"name": "Botswana",
"code": "BW"
},
{
"name": "Bouvet Island",
"code": "BV"
},
{
"name": "Brazil",
"code": "BR"
},
{
"name": "British Indian Ocean Territory",
"code": "IO"
},
{
"name": "British Virgin Islands",
"code": "VG"
},
{
"name": "Brunei",
"code": "BN"
},
{
"name": "Bulgaria",
"code": "BG"
},
{
"name": "Burkina Faso",
"code": "BF"
},
{
"name": "Burundi",
"code": "BI"
},
{
"name": "Cambodia",
"code": "KH"
},
{
"name": "Cameroon",
"code": "CM"
},
{
"name": "Canada",
"code": "CA"
},
{
"name": "Cape Verde",
"code": "CV"
},
{
"name": "Caribbean Netherlands",
"code": "BQ"
},
{
"name": "Cayman Islands",
"code": "KY"
},
{
"name": "Central African Republic",
"code": "CF"
},
{
"name": "Chad",
"code": "TD"
},
{
"name": "Chile",
"code": "CL"
},
{
"name": "China",
"code": "CN"
},
{
"name": "Christmas Island",
"code": "CX"
},
{
"name": "Cocos (Keeling) Islands",
"code": "CC"
},
{
"name": "Colombia",
"code": "CO"
},
{
"name": "Comoros",
"code": "KM"
},
{
"name": "Congo - Brazzaville",
"code": "CG"
},
{
"name": "Congo - Kinshasa",
"code": "CD"
},
{
"name": "Cook Islands",
"code": "CK"
},
{
"name": "Costa Rica",
"code": "CR"
},
{
"name": "Côte d’Ivoire",
"code": "CI"
},
{
"name": "Croatia",
"code": "HR"
},
{
"name": "Cuba",
"code": "CU"
},
{
"name": "Curaçao",
"code": "CW"
},
{
"name": "Cyprus",
"code": "CY"
},
{
"name": "Czechia",
"code": "CZ"
},
{
"name": "Denmark",
"code": "DK"
},
{
"name": "Djibouti",
"code": "DJ"
},
{
"name": "Dominica",
"code": "DM"
},
{
"name": "Dominican Republic",
"code": "DO"
},
{
"name": "Ecuador",
"code": "EC"
},
{
"name": "Egypt",
"code": "EG"
},
{
"name": "El Salvador",
"code": "SV"
},
{
"name": "Equatorial Guinea",
"code": "GQ"
},
{
"name": "Eritrea",
"code": "ER"
},
{
"name": "Estonia",
"code": "EE"
},
{
"name": "Eswatini",
"code": "SZ"
},
{
"name": "Ethiopia",
"code": "ET"
},
{
"name": "Falkland Islands",
"code": "FK"
},
{
"name": "Faroe Islands",
"code": "FO"
},
{
"name": "Fiji",
"code": "FJ"
},
{
"name": "Finland",
"code": "FI"
},
{
"name": "France",
"code": "FR"
},
{
"name": "French Guiana",
"code": "GF"
},
{
"name": "French Polynesia",
"code": "PF"
},
{
"name": "French Southern Territories",
"code": "TF"
},
{
"name": "Gabon",
"code": "GA"
},
{
"name": "Gambia",
"code": "GM"
},
{
"name": "Georgia",
"code": "GE"
},
{
"name": "Germany",
"code": "DE"
},
{
"name": "Ghana",
"code": "GH"
},
{
"name": "Gibraltar",
"code": "GI"
},
{
"name": "Greece",
"code": "GR"
},
{
"name": "Greenland",
"code": "GL"
},
{
"name": "Grenada",
"code": "GD"
},
{
"name": "Guadeloupe",
"code": "GP"
},
{
"name": "Guam",
"code": "GU"
},
{
"name": "Guatemala",
"code": "GT"
},
{
"name": "Guernsey",
"code": "GG"
},
{
"name": "Guinea",
"code": "GN"
},
{
"name": "Guinea-Bissau",
"code": "GW"
},
{
"name": "Guyana",
"code": "GY"
},
{
"name": "Haiti",
"code": "HT"
},
{
"name": "Heard & McDonald Islands",
"code": "HM"
},
{
"name": "Honduras",
"code": "HN"
},
{
"name": "Hong Kong SAR China",
"code": "HK"
},
{
"name": "Hungary",
"code": "HU"
},
{
"name": "Iceland",
"code": "IS"
},
{
"name": "India",
"code": "IN"
},
{
"name": "Indonesia",
"code": "ID"
},
{
"name": "Iran",
"code": "IR"
},
{
"name": "Iraq",
"code": "IQ"
},
{
"name": "Ireland",
"code": "IE"
},
{
"name": "Isle of Man",
"code": "IM"
},
{
"name": "Israel",
"code": "IL"
},
{
"name": "Italy",
"code": "IT"
},
{
"name": "Jamaica",
"code": "JM"
},
{
"name": "Japan",
"code": "JP"
},
{
"name": "Jersey",
"code": "JE"
},
{
"name": "Jordan",
"code": "JO"
},
{
"name": "Kazakhstan",
"code": "KZ"
},
{
"name": "Kenya",
"code": "KE"
},
{
"name": "Kiribati",
"code": "KI"
},
{
"name": "Kuwait",
"code": "KW"
},
{
"name": "Kyrgyzstan",
"code": "KG"
},
{
"name": "Laos",
"code": "LA"
},
{
"name": "Latvia",
"code": "LV"
},
{
"name": "Lebanon",
"code": "LB"
},
{
"name": "Lesotho",
"code": "LS"
},
{
"name": "Liberia",
"code": "LR"
},
{
"name": "Libya",
"code": "LY"
},
{
"name": "Liechtenstein",
"code": "LI"
},
{
"name": "Lithuania",
"code": "LT"
},
{
"name": "Luxembourg",
"code": "LU"
},
{
"name": "Macao SAR China",
"code": "MO"
},
{
"name": "Madagascar",
"code": "MG"
},
{
"name": "Malawi",
"code": "MW"
},
{
"name": "Malaysia",
"code": "MY"
},
{
"name": "Maldives",
"code": "MV"
},
{
"name": "Mali",
"code": "ML"
},
{
"name": "Malta",
"code": "MT"
},
{
"name": "Marshall Islands",
"code": "MH"
},
{
"name": "Martinique",
"code": "MQ"
},
{
"name": "Mauritania",
"code": "MR"
},
{
"name": "Mauritius",
"code": "MU"
},
{
"name": "Mayotte",
"code": "YT"
},
{
"name": "Mexico",
"code": "MX"
},
{
"name": "Micronesia",
"code": "FM"
},
{
"name": "Moldova",
"code": "MD"
},
{
"name": "Monaco",
"code": "MC"
},
{
"name": "Mongolia",
"code": "MN"
},
{
"name": "Montenegro",
"code": "ME"
},
{
"name": "Montserrat",
"code": "MS"
},
{
"name": "Morocco",
"code": "MA"
},
{
"name": "Mozambique",
"code": "MZ"
},
{
"name": "Myanmar (Burma)",
"code": "MM"
},
{
"name": "Namibia",
"code": "NA"
},
{
"name": "Nauru",
"code": "NR"
},
{
"name": "Nepal",
"code": "NP"
},
{
"name": "Netherlands",
"code": "NL"
},
{
"name": "New Caledonia",
"code": "NC"
},
{
"name": "New Zealand",
"code": "NZ"
},
{
"name": "Nicaragua",
"code": "NI"
},
{
"name": "Niger",
"code": "NE"
},
{
"name": "Nigeria",
"code": "NG"
},
{
"name": "Niue",
"code": "NU"
},
{
"name": "Norfolk Island",
"code": "NF"
},
{
"name": "North Korea",
"code": "KP"
},
{
"name": "North Macedonia",
"code": "MK"
},
{
"name": "Northern Mariana Islands",
"code": "MP"
},
{
"name": "Norway",
"code": "NO"
},
{
"name": "Oman",
"code": "OM"
},
{
"name": "Pakistan",
"code": "PK"
},
{
"name": "Palau",
"code": "PW"
},
{
"name": "Palestinian Territories",
"code": "PS"
},
{
"name": "Panama",
"code": "PA"
},
{
"name": "Papua New Guinea",
"code": "PG"
},
{
"name": "Paraguay",
"code": "PY"
},
{
"name": "Peru",
"code": "PE"
},
{
"name": "Philippines",
"code": "PH"
},
{
"name": "Pitcairn Islands",
"code": "PN"
},
{
"name": "Poland",
"code": "PL"
},
{
"name": "Portugal",
"code": "PT"
},
{
"name": "Puerto Rico",
"code": "PR"
},
{
"name": "Qatar",
"code": "QA"
},
{
"name": "Réunion",
"code": "RE"
},
{
"name": "Romania",
"code": "RO"
},
{
"name": "Russia",
"code": "RU"
},
{
"name": "Rwanda",
"code": "RW"
},
{
"name": "Samoa",
"code": "WS"
},
{
"name": "San Marino",
"code": "SM"
},
{
"name": "São Tomé & Príncipe",
"code": "ST"
},
{
"name": "Saudi Arabia",
"code": "SA"
},
{
"name": "Senegal",
"code": "SN"
},
{
"name": "Serbia",
"code": "RS"
},
{
"name": "Seychelles",
"code": "SC"
},
{
"name": "Sierra Leone",
"code": "SL"
},
{
"name": "Singapore",
"code": "SG"
},
{
"name": "Sint Maarten",
"code": "SX"
},
{
"name": "Slovakia",
"code": "SK"
},
{
"name": "Slovenia",
"code": "SI"
},
{
"name": "Solomon Islands",
"code": "SB"
},
{
"name": "Somalia",
"code": "SO"
},
{
"name": "South Africa",
"code": "ZA"
},
{
"name": "South Georgia & South Sandwich Islands",
"code": "GS"
},
{
"name": "South Korea",
"code": "KR"
},
{
"name": "South Sudan",
"code": "SS"
},
{
"name": "Spain",
"code": "ES"
},
{
"name": "Sri Lanka",
"code": "LK"
},
{
"name": "St. Barthélemy",
"code": "BL"
},
{
"name": "St. Helena",
"code": "SH"
},
{
"name": "St. Kitts & Nevis",
"code": "KN"
},
{
"name": "St. Lucia",
"code": "LC"
},
{
"name": "St. Martin",
"code": "MF"
},
{
"name": "St. Pierre & Miquelon",
"code": "PM"
},
{
"name": "St. Vincent & Grenadines",
"code": "VC"
},
{
"name": "Sudan",
"code": "SD"
},
{
"name": "Suriname",
"code": "SR"
},
{
"name": "Svalbard & Jan Mayen",
"code": "SJ"
},
{
"name": "Sweden",
"code": "SE"
},
{
"name": "Switzerland",
"code": "CH"
},
{
"name": "Syria",
"code": "SY"
},
{
"name": "Taiwan",
"code": "TW"
},
{
"name": "Tajikistan",
"code": "TJ"
},
{
"name": "Tanzania",
"code": "TZ"
},
{
"name": "Thailand",
"code": "TH"
},
{
"name": "Timor-Leste",
"code": "TL"
},
{
"name": "Togo",
"code": "TG"
},
{
"name": "Tokelau",
"code": "TK"
},
{
"name": "Tonga",
"code": "TO"
},
{
"name": "Trinidad & Tobago",
"code": "TT"
},
{
"name": "Tunisia",
"code": "TN"
},
{
"name": "Turkey",
"code": "TR"
},
{
"name": "Turkmenistan",
"code": "TM"
},
{
"name": "Turks & Caicos Islands",
"code": "TC"
},
{
"name": "Tuvalu",
"code": "TV"
},
{
"name": "U.S. Outlying Islands",
"code": "UM"
},
{
"name": "U.S. Virgin Islands",
"code": "VI"
},
{
"name": "Uganda",
"code": "UG"
},
{
"name": "Ukraine",
"code": "UA"
},
{
"name": "United Arab Emirates",
"code": "AE"
},
{
"name": "United Kingdom",
"code": "GB"
},
{
"name": "United States",
"code": "US"
},
{
"name": "Uruguay",
"code": "UY"
},
{
"name": "Uzbekistan",
"code": "UZ"
},
{
"name": "Vanuatu",
"code": "VU"
},
{
"name": "Vatican City",
"code": "VA"
},
{
"name": "Venezuela",
"code": "VE"
},
{
"name": "Vietnam",
"code": "VN"
},
{
"name": "Wallis & Futuna",
"code": "WF"
},
{
"name": "Western Sahara",
"code": "EH"
},
{
"name": "Yemen",
"code": "YE"
},
{
"name": "Zambia",
"code": "ZM"
},
{
"name": "Zimbabwe",
"code": "ZW"
}
]
}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