Skip to main content
POST
/
beneficiaries
Create a beneficiary
curl --request POST \
  --url https://api.notchpay.co/beneficiaries \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "cm.mtn",
  "name": "John Doe",
  "account_number": 237680000000,
  "email": "john@example.com",
  "phone": 237680000000,
  "description": "Employé",
  "country": "CM",
  "reference": "ref_123456789"
}
'
import requests

url = "https://api.notchpay.co/beneficiaries"

payload = {
"channel": "cm.mtn",
"name": "John Doe",
"account_number": 237680000000,
"email": "john@example.com",
"phone": 237680000000,
"description": "Employé",
"country": "CM",
"reference": "ref_123456789"
}
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({
channel: 'cm.mtn',
name: 'John Doe',
account_number: 237680000000,
email: 'john@example.com',
phone: 237680000000,
description: 'Employé',
country: 'CM',
reference: 'ref_123456789'
})
};

fetch('https://api.notchpay.co/beneficiaries', 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/beneficiaries",
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([
'channel' => 'cm.mtn',
'name' => 'John Doe',
'account_number' => 237680000000,
'email' => 'john@example.com',
'phone' => 237680000000,
'description' => 'Employé',
'country' => 'CM',
'reference' => 'ref_123456789'
]),
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/beneficiaries"

payload := strings.NewReader("{\n \"channel\": \"cm.mtn\",\n \"name\": \"John Doe\",\n \"account_number\": 237680000000,\n \"email\": \"john@example.com\",\n \"phone\": 237680000000,\n \"description\": \"Employé\",\n \"country\": \"CM\",\n \"reference\": \"ref_123456789\"\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/beneficiaries")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"cm.mtn\",\n \"name\": \"John Doe\",\n \"account_number\": 237680000000,\n \"email\": \"john@example.com\",\n \"phone\": 237680000000,\n \"description\": \"Employé\",\n \"country\": \"CM\",\n \"reference\": \"ref_123456789\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.notchpay.co/beneficiaries")

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 \"channel\": \"cm.mtn\",\n \"name\": \"John Doe\",\n \"account_number\": 237680000000,\n \"email\": \"john@example.com\",\n \"phone\": 237680000000,\n \"description\": \"Employé\",\n \"country\": \"CM\",\n \"reference\": \"ref_123456789\"\n}"

response = http.request(request)
puts response.read_body
{
  "code": 201,
  "status": "Created",
  "message": "Beneficiary created successfully",
  "beneficiary": "<unknown>"
}

Authorizations

Authorization
string
header
required

Body

application/json
channel
string
required
Example:

"cm.mtn"

name
string
required
Example:

"John Doe"

account_number
string
required
Example:

237680000000

email
string
required
Example:

"john@example.com"

phone
string
Example:

237680000000

description
string
Example:

"Employé"

country
string
Example:

"CM"

reference
string
Example:

"ref_123456789"

Response

Beneficiary created

code
integer
required
Example:

201

status
string
required
Example:

"Created"

message
string
required
Example:

"Beneficiary created successfully"

beneficiary
any
required