Create

Recipient​

Endpoints
GET/transfers/{reference}GET/recipientsPOST/recipients

Create​

Headers
  • X-Grant
    string
Body
application/json
channel
string

Payment channel to use for the given recipient

number
string

Number to receive found

phone
string

Recipient phone number (contact only)

email
string

Recipient email address (contact only for mobile money) [required for paypal transfer]

country
string

The two-letter country code in accordance with (ISO 3166-1 alpha-2)[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] standard.

name
string

Recipient name

description
string

recipient description or note

reference
string

Your unique reference

Responses
  • 200

    Successful response

  • 401

    Unauthorized

POST/recipients
Shell cURL
curl --request POST \
  --url https://api.notchpay.co/recipients \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "cm.mobile",
  "number": "+237656019261",
  "phone": "+237655632895",
  "email": "hello@notchpay.co",
  "country": "MX",
  "name": "Benjamin Maggio",
  "description": "Hic blanditiis voluptatem nobis ut saepe dolorem molestiae dolorum.",
  "reference": "3RAV4gZLesBAXTrwiuUDLnJGSAS4RVEbM5"
}'
No Body

Successful response

2.0.0
OAS 3.1.0

API Reference

The Notch Pay API is designed to provide you with a simple and powerful integration with our payment platform. Here are the fundamental principles that guide our API:

RESTful Architecture

Our API is built on the REST (Representational State Transfer) architecture, providing you with intuitive and predictable URLs for interacting with Notch Pay resources (payments, customers, transactions, etc.).

Request and Response Format

Requests: Requests are sent in the application/json format for maximum compatibility. Responses: All responses are returned in JSON format, clearly structured for easy processing in your application.

Standard HTTP Response Codes

We use standard HTTP response codes to indicate the success or failure of requests, providing you with accurate information about the outcome of each interaction.

Secure Authentication

Authentication is ensured through unique API keys that you obtain when you sign up. These keys ensure that only authorized applications can access your Notch Pay account.

Test Mode

Our API offers a comprehensive test mode that allows you to develop and test your integration without affecting your live data or interacting with banking networks.

Continuous Evolution

We regularly update our API with new features and improvements. Check our documentation regularly to stay informed about the latest developments.

Individual Resources

Our API handles resources individually. Each request should focus on a single resource at a time to ensure the consistency and reliability of operations.

Ready to get started? Explore our detailed integration guides and comprehensive API references to start accepting payments seamlessly with Notch Pay.

Additional Key Points to Consider for Your Notch Pay Documentation:

Code Examples: Provide concrete code examples in different languages to help developers quickly integrate the API.

Support Channels: Clearly indicate how developers can get help if needed (email, forum, etc.).

Client Libraries
Shell
Ruby
Node.js
PHP
Python
More
cURL Shell

Recipient​

Endpoints
GET/transfers/{reference}GET/recipientsPOST/recipients

Fetch​

Headers
  • X-Grant
    string
Responses
  • 200

    Successful response

  • 401

    Unauthorized

  • 404

    Transfers Not Found

GET/transfers/{reference}
Shell cURL
curl --request GET \
  --url https://api.notchpay.co/transfers/__REFERENCE__
No Body

Successful response