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
All API requests should be made to:
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.
Test cards and accounts are available in the Testing Guide.
Response Format
HTTP Status Codes
Success Codes (2xx)
Success Codes (2xx)
Client Error Codes (4xx)
Client Error Codes (4xx)
Bad Request
The request was invalid or cannot be served
Unauthorized
Authentication credentials are missing or invalid
Forbidden
The authenticated user doesn’t have permission
Not Found
The requested resource doesn’t exist
Unprocessable Entity
The request was well-formed but contains semantic errors
Too Many Requests
Rate limit exceeded
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.1
Rate Limit Headers
Each response includes headers that provide information about your current rate limit status:
2
Handling Rate Limits
When you receive a Implement exponential backoff in your code to handle rate limiting gracefully.
429 response, the Retry-After header indicates how many seconds to wait before making another request.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
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
- Official SDKs
- Community Libraries
JavaScript
Node.js and browser SDK
PHP
PHP SDK for server-side integration
Python
Python SDK for server-side integration
Mobile
iOS and Android SDKs
Need Help?
API Errors
Troubleshoot common API errors
Support Team
Contact our technical support team
Developer Community
Connect with other developers
Ready to start building? Check out our Getting Started Guide to make your first API request.