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.
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
Create an Account
Sign up for a Notch Pay account at business.notchpay.co
Get Your API Keys
Find your API keys in your dashboard under Settings > API Keys
Make Your First API Call
Follow our Quickstart Guide to make your first API call
Getting Started
Base URL
All API requests should be made to:
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.
Development & Testing
Use test API keys that start with test_
Test transactions don’t affect real money and are only visible in test mode.
Production
Use live API keys that start with live_
Live transactions involve real money and appear in your Notch Pay dashboard.
Response Format
HTTP Status Codes
Rate Limiting
Rate Limit Headers
Each response includes headers that provide information about your current rate limit status:
Handling Rate Limits
When you receive a 429 response, the Retry-After header indicates how many seconds to wait before making another request.
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