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

Payment​

The Payments API allows you create and manage payments on your integration.

Endpoints
POST/paymentsGET/paymentsGET/payments/{reference}POST/payments/{reference}DELETE/payments/{reference}GET/payments/search

Initialize​

This endpoint allows you to make a payment.

Body
application/json
amount
required
numeric

amount to charge to customer

currency
required
string

Three-letter ISO currency code.

customer
object

Information about customer

theming
object

Collect page customization

reference
string

Unique reference for your payments

description
string
max: 
256

Payment description.

callback
string

URL to redirect after payment processing.

locked_currency
string

The currency with which the payment information will be displayed to your customer.

locked_country
string

Only the payment methods available for this country will be available on the payment page.

Responses
  • 201

    Successful response

  • 401

    Unauthorized

  • 409

    Conflict Reference already existing

  • 422

    Validation error

POST/payments
Shell cURL
curl --request POST \
  --url https://api.notchpay.co/payments \
  --header 'Content-Type: application/json' \
  --data '{
  "currency": "XAF",
  "amount": 100,
  "reference": "your_unique_reference_id_479"
}'
{
  "status": "Accepted",
  "message": "Payment initialized",
  "code": 201,
  "transaction": {
    "amount": 100,
    "amount_total": 100,
    "sandbox": false,
    "fee": 0,
    "converted_amount": 100,
    "customer": "cus.HinOxDlooNXjMBPq",
    "description": "Eaque sed dolores earum sunt ipsa consequatur veniam quia.",
    "reference": "trx.9aDtumnnMMBEw1ZCuj7IFWzc",
    "merchant_reference": "your_unique_reference_id_479",
    "trxref": "your_unique_reference_id_479",
    "status": "pending",
    "currency": "XAF",
    "locked_currency": "XAF",
    "callback": "https://jada.info",
    "geo": "127.0.0.1",
    "created_at": "2024-06-17T07:27:11.000000Z"
  },
  "authorization_url": "https://pay.notchpay.co/IOvSUHqMIWGqnp7ScbYpRLuNZuytePNGmssjVoIjr570lLcMOHeU4ymcnurlEPtyvJ2DqozzUVdCMDyDb2aDyOv6AlZG1zAgX2o9GuYwCpctOkqxMJLMw1v4YFjmTM5BA4ILL2HKq8BixOm0N4BDKXqcfoI4sTj000wKVXhk117uBOgjN96S3kE8Pl48a9wA"
}

Successful response