Skip to main content
POST
/
transfers
Initiate a transfer
curl --request POST \
  --url https://api.notchpay.co/transfers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 5000,
  "currency": "XAF",
  "beneficiary": "ben_123456789",
  "description": "Paiement de salaire",
  "channel": "cm.mtn",
  "recipient": "ben_123456789",
  "reference": "ref_123456789"
}
'
import requests

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

payload = {
"amount": 5000,
"currency": "XAF",
"beneficiary": "ben_123456789",
"description": "Paiement de salaire",
"channel": "cm.mtn",
"recipient": "ben_123456789",
"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({
amount: 5000,
currency: 'XAF',
beneficiary: 'ben_123456789',
description: 'Paiement de salaire',
channel: 'cm.mtn',
recipient: 'ben_123456789',
reference: 'ref_123456789'
})
};

fetch('https://api.notchpay.co/transfers', 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/transfers",
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',
'beneficiary' => 'ben_123456789',
'description' => 'Paiement de salaire',
'channel' => 'cm.mtn',
'recipient' => 'ben_123456789',
'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/transfers"

payload := strings.NewReader("{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"beneficiary\": \"ben_123456789\",\n \"description\": \"Paiement de salaire\",\n \"channel\": \"cm.mtn\",\n \"recipient\": \"ben_123456789\",\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/transfers")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 5000,\n \"currency\": \"XAF\",\n \"beneficiary\": \"ben_123456789\",\n \"description\": \"Paiement de salaire\",\n \"channel\": \"cm.mtn\",\n \"recipient\": \"ben_123456789\",\n \"reference\": \"ref_123456789\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"beneficiary\": \"ben_123456789\",\n \"description\": \"Paiement de salaire\",\n \"channel\": \"cm.mtn\",\n \"recipient\": \"ben_123456789\",\n \"reference\": \"ref_123456789\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "Accepted",
  "message": "Transfer initialized",
  "code": 201,
  "transfer": "<unknown>"
}

Authorizations

Authorization
string
header
required

Body

application/json
amount
number
required
Example:

5000

currency
string
required
Example:

"XAF"

beneficiary
string
required
Example:

"ben_123456789"

description
string
required
Example:

"Paiement de salaire"

channel
string
Example:

"cm.mtn"

recipient
string
Example:

"ben_123456789"

reference
string
Example:

"ref_123456789"

Response

Transfer initialized

status
string
required
Example:

"Accepted"

message
string
required
Example:

"Transfer initialized"

code
integer
required
Example:

201

transfer
any
required