Initialize a payment
curl --request POST \
--url https://api.notchpay.co/payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 5000,
"currency": "XAF",
"email": "john@example.com",
"phone": 237600000000,
"customer": "cus_123456789",
"description": "Paiement pour commande",
"reference": "order_123",
"callback": "https://example.com/callback",
"locked_currency": "XAF",
"locked_channel": "cm.mtn",
"locked_country": "CM",
"items": [
{}
],
"shipping": {},
"address": {},
"customer_meta": {}
}
'import requests
url = "https://api.notchpay.co/payments"
payload = {
"amount": 5000,
"currency": "XAF",
"email": "john@example.com",
"phone": 237600000000,
"customer": "cus_123456789",
"description": "Paiement pour commande",
"reference": "order_123",
"callback": "https://example.com/callback",
"locked_currency": "XAF",
"locked_channel": "cm.mtn",
"locked_country": "CM",
"items": [{}],
"shipping": {},
"address": {},
"customer_meta": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 5000,
currency: 'XAF',
email: 'john@example.com',
phone: 237600000000,
customer: 'cus_123456789',
description: 'Paiement pour commande',
reference: 'order_123',
callback: 'https://example.com/callback',
locked_currency: 'XAF',
locked_channel: 'cm.mtn',
locked_country: 'CM',
items: [{}],
shipping: {},
address: {},
customer_meta: {}
})
};
fetch('https://api.notchpay.co/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.notchpay.co/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 5000,
'currency' => 'XAF',
'email' => 'john@example.com',
'phone' => 237600000000,
'customer' => 'cus_123456789',
'description' => 'Paiement pour commande',
'reference' => 'order_123',
'callback' => 'https://example.com/callback',
'locked_currency' => 'XAF',
'locked_channel' => 'cm.mtn',
'locked_country' => 'CM',
'items' => [
[
]
],
'shipping' => [
],
'address' => [
],
'customer_meta' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.notchpay.co/payments"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"customer\": \"cus_123456789\",\n \"description\": \"Paiement pour commande\",\n \"reference\": \"order_123\",\n \"callback\": \"https://example.com/callback\",\n \"locked_currency\": \"XAF\",\n \"locked_channel\": \"cm.mtn\",\n \"locked_country\": \"CM\",\n \"items\": [\n {}\n ],\n \"shipping\": {},\n \"address\": {},\n \"customer_meta\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.notchpay.co/payments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"customer\": \"cus_123456789\",\n \"description\": \"Paiement pour commande\",\n \"reference\": \"order_123\",\n \"callback\": \"https://example.com/callback\",\n \"locked_currency\": \"XAF\",\n \"locked_channel\": \"cm.mtn\",\n \"locked_country\": \"CM\",\n \"items\": [\n {}\n ],\n \"shipping\": {},\n \"address\": {},\n \"customer_meta\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.notchpay.co/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"customer\": \"cus_123456789\",\n \"description\": \"Paiement pour commande\",\n \"reference\": \"order_123\",\n \"callback\": \"https://example.com/callback\",\n \"locked_currency\": \"XAF\",\n \"locked_channel\": \"cm.mtn\",\n \"locked_country\": \"CM\",\n \"items\": [\n {}\n ],\n \"shipping\": {},\n \"address\": {},\n \"customer_meta\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "Accepted",
"message": "Payment initialized",
"code": 201,
"transaction": "<unknown>",
"authorization_url": "https://pay.notchpay.co/pay_123456789"
}API Reference
Initialize a payment
POST
/
payments
Initialize a payment
curl --request POST \
--url https://api.notchpay.co/payments \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 5000,
"currency": "XAF",
"email": "john@example.com",
"phone": 237600000000,
"customer": "cus_123456789",
"description": "Paiement pour commande",
"reference": "order_123",
"callback": "https://example.com/callback",
"locked_currency": "XAF",
"locked_channel": "cm.mtn",
"locked_country": "CM",
"items": [
{}
],
"shipping": {},
"address": {},
"customer_meta": {}
}
'import requests
url = "https://api.notchpay.co/payments"
payload = {
"amount": 5000,
"currency": "XAF",
"email": "john@example.com",
"phone": 237600000000,
"customer": "cus_123456789",
"description": "Paiement pour commande",
"reference": "order_123",
"callback": "https://example.com/callback",
"locked_currency": "XAF",
"locked_channel": "cm.mtn",
"locked_country": "CM",
"items": [{}],
"shipping": {},
"address": {},
"customer_meta": {}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 5000,
currency: 'XAF',
email: 'john@example.com',
phone: 237600000000,
customer: 'cus_123456789',
description: 'Paiement pour commande',
reference: 'order_123',
callback: 'https://example.com/callback',
locked_currency: 'XAF',
locked_channel: 'cm.mtn',
locked_country: 'CM',
items: [{}],
shipping: {},
address: {},
customer_meta: {}
})
};
fetch('https://api.notchpay.co/payments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.notchpay.co/payments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 5000,
'currency' => 'XAF',
'email' => 'john@example.com',
'phone' => 237600000000,
'customer' => 'cus_123456789',
'description' => 'Paiement pour commande',
'reference' => 'order_123',
'callback' => 'https://example.com/callback',
'locked_currency' => 'XAF',
'locked_channel' => 'cm.mtn',
'locked_country' => 'CM',
'items' => [
[
]
],
'shipping' => [
],
'address' => [
],
'customer_meta' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.notchpay.co/payments"
payload := strings.NewReader("{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"customer\": \"cus_123456789\",\n \"description\": \"Paiement pour commande\",\n \"reference\": \"order_123\",\n \"callback\": \"https://example.com/callback\",\n \"locked_currency\": \"XAF\",\n \"locked_channel\": \"cm.mtn\",\n \"locked_country\": \"CM\",\n \"items\": [\n {}\n ],\n \"shipping\": {},\n \"address\": {},\n \"customer_meta\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.notchpay.co/payments")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"customer\": \"cus_123456789\",\n \"description\": \"Paiement pour commande\",\n \"reference\": \"order_123\",\n \"callback\": \"https://example.com/callback\",\n \"locked_currency\": \"XAF\",\n \"locked_channel\": \"cm.mtn\",\n \"locked_country\": \"CM\",\n \"items\": [\n {}\n ],\n \"shipping\": {},\n \"address\": {},\n \"customer_meta\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.notchpay.co/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"email\": \"john@example.com\",\n \"phone\": 237600000000,\n \"customer\": \"cus_123456789\",\n \"description\": \"Paiement pour commande\",\n \"reference\": \"order_123\",\n \"callback\": \"https://example.com/callback\",\n \"locked_currency\": \"XAF\",\n \"locked_channel\": \"cm.mtn\",\n \"locked_country\": \"CM\",\n \"items\": [\n {}\n ],\n \"shipping\": {},\n \"address\": {},\n \"customer_meta\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "Accepted",
"message": "Payment initialized",
"code": 201,
"transaction": "<unknown>",
"authorization_url": "https://pay.notchpay.co/pay_123456789"
}Authorizations
ApiKeyAuthSyncAuth
Body
application/json
- Option 1
- Option 2
- Option 3
Example:
5000
Example:
"XAF"
Example:
"john@example.com"
Example:
237600000000
Example:
"cus_123456789"
Example:
"Paiement pour commande"
Example:
"order_123"
Example:
"https://example.com/callback"
Example:
"XAF"
Example:
"cm.mtn"
Example:
"CM"
Was this page helpful?
⌘I