> ## Documentation Index > Fetch the complete documentation index at: https://developer.notchpay.co/llms.txt > Use this file to discover all available pages before exploring further. # API Reference > Complete reference documentation for the Notch Pay API # 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.

RESTful Design

Predictable resource-oriented URLs

JSON Responses

All responses are in JSON format

Comprehensive Error Handling

Detailed error messages and codes

Webhooks Support

Real-time event notifications

Sign up for a Notch Pay account at business.notchpay.co Find your API keys in your dashboard under Settings > API Keys Follow our Quickstart Guide to make your first API call ## Getting Started All API requests should be made to: ```bash theme={null} https://api.notchpay.co ``` Include your API key in the `Authorization` header: ```bash theme={null} 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.

Test cards and accounts are available in the Testing Guide.

Production

Use live API keys that start with live\_

Live transactions involve real money and appear in your Notch Pay dashboard.

Only use live keys when your integration is thoroughly tested and ready for production.

## Response Format ```json Success Response theme={null} { "code": 200, "status": "OK", "message": "Descriptive message", "data": { "id": "pay_123456789", "amount": 5000, "currency": "XAF", "status": "complete" } } ``` ```json Error Response theme={null} { "code": 400, "status": "Bad Request", "message": "Error message", "errors": { "field_name": ["Error description"] } } ``` ## HTTP Status Codes The request was completed A new resource was created The request has been accepted for processing The request was invalid or cannot be served Authentication credentials are missing or invalid The authenticated user doesn't have permission The requested resource doesn't exist The request was well-formed but contains semantic errors Rate limit exceeded An error occurred on the server The server is temporarily unavailable ## Rate Limiting The Notch Pay API implements rate limiting to protect against abuse. If you exceed the rate limit, you'll receive a `429 Too Many Requests` response. 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 ``` 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 Create, retrieve, and manage payments Send money to beneficiaries Create and manage customer information Manage recipients for money transfers Configure and manage webhook endpoints Check your account balance Get information about payment channels, countries, and currencies Learn about authentication methods and security ## API Versioning The current version of the API does not require a version specifier in the URL. Future versions may be accessed by including a version number in the URL or headers. ## SDKs and Libraries Node.js and browser SDK PHP SDK for server-side integration Python SDK for server-side integration iOS and Android SDKs Laravel package for Notch Pay WordPress plugin for Notch Pay WooCommerce payment gateway ## Need Help? Troubleshoot common API errors Contact our technical support team Connect with other developers Ready to start building? Check out our [Getting Started Guide](/get-started/index) to make your first API request.