​
API Reference

Complete Notch Pay API Documentation

This reference provides detailed information about all endpoints, request parameters, and response formats for the Notch Pay API.

The Notch Pay API is organized around REST principles. It uses standard HTTP verbs, returns JSON-encoded responses, and uses standard HTTP response codes to indicate API errors.

Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients.

​
Getting Started

Base URL

All API requests should be made to:
https://api.notchpay.co

Authentication

Include your API key in the Authorization header:
Authorization: YOUR_PUBLIC_KEY
Learn more about authentication →

​
API Environments

Development & Testing

Use test API keys that start with test_

Test transactions don’t affect real money and are only visible in test mode.

​
Response Format

{
  "code": 200,
  "status": "OK",
  "message": "Descriptive message",
  "data": {
    "id": "pay_123456789",
    "amount": 5000,
    "currency": "XAF",
    "status": "complete"
  }
}

​
HTTP Status Codes

Success Codes (2xx)

​
Rate Limiting

1

Rate Limit Headers

Each response includes headers that provide information about your current rate limit status:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 98
X-RateLimit-Reset: 1620000000
2

Handling Rate Limits

When you receive a 429 response, the Retry-After header indicates how many seconds to wait before making another request.
Retry-After: 30
Implement exponential backoff in your code to handle rate limiting gracefully.

​
API Resources

Payments

Create, retrieve, and manage payments

Transfers

Send money to beneficiaries

Customers

Create and manage customer information

Beneficiaries

Manage recipients for money transfers

Webhooks

Configure and manage webhook endpoints

Balance

Check your account balance

Resources

Get information about payment channels, countries, and currencies

Authentication

Learn about authentication methods and security

​
API Versioning

​
SDKs and Libraries

​
Need Help?

API Errors

Troubleshoot common API errors

Support Team

Contact our technical support team

Developer Community

Connect with other developers