Beneficiary
Create beneficiary
This endpoint allows you to create a beneficiary.
POST
/
beneficiary
Create beneficiary
curl --request POST \
--url https://processor-prod.up.railway.app/beneficiary \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"currency": "ngn",
"identity_id": "68bf2de7196a18d7bd165ffb",
"details": {
"bank_code": "100004",
"account_number": "1234567890"
}
}
'import requests
url = "https://processor-prod.up.railway.app/beneficiary"
payload = {
"currency": "ngn",
"identity_id": "68bf2de7196a18d7bd165ffb",
"details": {
"bank_code": "100004",
"account_number": "1234567890"
}
}
headers = {
"x-service-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-service-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: 'ngn',
identity_id: '68bf2de7196a18d7bd165ffb',
details: {bank_code: '100004', account_number: '1234567890'}
})
};
fetch('https://processor-prod.up.railway.app/beneficiary', 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://processor-prod.up.railway.app/beneficiary",
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([
'currency' => 'ngn',
'identity_id' => '68bf2de7196a18d7bd165ffb',
'details' => [
'bank_code' => '100004',
'account_number' => '1234567890'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-service-key: <api-key>"
],
]);
$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://processor-prod.up.railway.app/beneficiary"
payload := strings.NewReader("{\n \"currency\": \"ngn\",\n \"identity_id\": \"68bf2de7196a18d7bd165ffb\",\n \"details\": {\n \"bank_code\": \"100004\",\n \"account_number\": \"1234567890\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-service-key", "<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://processor-prod.up.railway.app/beneficiary")
.header("x-service-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"ngn\",\n \"identity_id\": \"68bf2de7196a18d7bd165ffb\",\n \"details\": {\n \"bank_code\": \"100004\",\n \"account_number\": \"1234567890\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processor-prod.up.railway.app/beneficiary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-service-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"ngn\",\n \"identity_id\": \"68bf2de7196a18d7bd165ffb\",\n \"details\": {\n \"bank_code\": \"100004\",\n \"account_number\": \"1234567890\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"status": 201,
"message": "Beneficiary created successfully",
"timestamp": "2025-09-08T20:40:35.538Z",
"data": {
"id": "68bf2eba196a18d7bd166184"
}
}Authorizations
Body
application/json
The currency code for the beneficiary
Available options:
NGN Example:
"ngn"
The identity ID associated with this beneficiary
Example:
"68bf2de7196a18d7bd165ffb"
Banking details based country
- Nigerian Bank Account
- Other Bank Account
Show child attributes
Show child attributes
⌘I
Create beneficiary
curl --request POST \
--url https://processor-prod.up.railway.app/beneficiary \
--header 'Content-Type: application/json' \
--header 'x-service-key: <api-key>' \
--data '
{
"currency": "ngn",
"identity_id": "68bf2de7196a18d7bd165ffb",
"details": {
"bank_code": "100004",
"account_number": "1234567890"
}
}
'import requests
url = "https://processor-prod.up.railway.app/beneficiary"
payload = {
"currency": "ngn",
"identity_id": "68bf2de7196a18d7bd165ffb",
"details": {
"bank_code": "100004",
"account_number": "1234567890"
}
}
headers = {
"x-service-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-service-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: 'ngn',
identity_id: '68bf2de7196a18d7bd165ffb',
details: {bank_code: '100004', account_number: '1234567890'}
})
};
fetch('https://processor-prod.up.railway.app/beneficiary', 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://processor-prod.up.railway.app/beneficiary",
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([
'currency' => 'ngn',
'identity_id' => '68bf2de7196a18d7bd165ffb',
'details' => [
'bank_code' => '100004',
'account_number' => '1234567890'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-service-key: <api-key>"
],
]);
$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://processor-prod.up.railway.app/beneficiary"
payload := strings.NewReader("{\n \"currency\": \"ngn\",\n \"identity_id\": \"68bf2de7196a18d7bd165ffb\",\n \"details\": {\n \"bank_code\": \"100004\",\n \"account_number\": \"1234567890\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-service-key", "<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://processor-prod.up.railway.app/beneficiary")
.header("x-service-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"ngn\",\n \"identity_id\": \"68bf2de7196a18d7bd165ffb\",\n \"details\": {\n \"bank_code\": \"100004\",\n \"account_number\": \"1234567890\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://processor-prod.up.railway.app/beneficiary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-service-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"ngn\",\n \"identity_id\": \"68bf2de7196a18d7bd165ffb\",\n \"details\": {\n \"bank_code\": \"100004\",\n \"account_number\": \"1234567890\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"status": 201,
"message": "Beneficiary created successfully",
"timestamp": "2025-09-08T20:40:35.538Z",
"data": {
"id": "68bf2eba196a18d7bd166184"
}
}