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.
- Overview
- Features
- Getting Started
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
Authentication
API Environments
- Test Environment
- Live Environment
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
HTTP Status Codes
Success Codes (2xx)
Success Codes (2xx)
Client Error Codes (4xx)
Client Error Codes (4xx)
Rate Limiting
429 Too Many Requests
response.Rate Limit Headers
Handling Rate Limits
429
response, the Retry-After
header indicates how many seconds to wait before making another request.API Resources
Payments
Transfers
Customers
Beneficiaries
Webhooks
Balance
Resources
Authentication
API Versioning
SDKs and Libraries
- Official SDKs
- Community Libraries