Create Split Beneficiary
curl --request POST \
--url https://checkout-staging.embedly.ng/api/v1/split-beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"organizationId": "<string>",
"beneficiaryName": "<string>",
"accountNumber": "<string>",
"bankCode": "<string>",
"bankName": "<string>",
"beneficiaryAlias": "<string>"
}
'import requests
url = "https://checkout-staging.embedly.ng/api/v1/split-beneficiaries"
payload = {
"organizationId": "<string>",
"beneficiaryName": "<string>",
"accountNumber": "<string>",
"bankCode": "<string>",
"bankName": "<string>",
"beneficiaryAlias": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organizationId: '<string>',
beneficiaryName: '<string>',
accountNumber: '<string>',
bankCode: '<string>',
bankName: '<string>',
beneficiaryAlias: '<string>'
})
};
fetch('https://checkout-staging.embedly.ng/api/v1/split-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://checkout-staging.embedly.ng/api/v1/split-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([
'organizationId' => '<string>',
'beneficiaryName' => '<string>',
'accountNumber' => '<string>',
'bankCode' => '<string>',
'bankName' => '<string>',
'beneficiaryAlias' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"bankName\": \"<string>\",\n \"beneficiaryAlias\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"bankName\": \"<string>\",\n \"beneficiaryAlias\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://checkout-staging.embedly.ng/api/v1/split-beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"bankName\": \"<string>\",\n \"beneficiaryAlias\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"message": "Split beneficiary created successfully",
"data": {
"id": "1c7e2c80-9f8c-4bd8-8c9d-bd63810c5df9",
"organizationId": "0075b72d-6648-11f0-a7cf-0274f77d4a81",
"beneficiaryName": "string",
"accountNumber": "4278816938",
"bankCode": "string",
"bankName": "string",
"beneficiaryAlias": "string",
"isActive": true,
"createdAt": "2026-02-16T07:57:04.4688132Z",
"updatedAt": null
}
}
{
"statusCode": 400,
"message": "Validation failed",
"errors": [
"The request field is required.",
"The JSON value could not be converted to System.Guid. Path: $.organizationId | LineNumber: 1 | BytePositionInLine: 60."
],
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
Split Checkout
Create Split Beneficiary
This endpoint generates a new checkout split beneficiary for an organization. Organization must be active and have configured primary and secondary prefixes.
POST
/
api
/
v1
/
split-beneficiaries
Create Split Beneficiary
curl --request POST \
--url https://checkout-staging.embedly.ng/api/v1/split-beneficiaries \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"organizationId": "<string>",
"beneficiaryName": "<string>",
"accountNumber": "<string>",
"bankCode": "<string>",
"bankName": "<string>",
"beneficiaryAlias": "<string>"
}
'import requests
url = "https://checkout-staging.embedly.ng/api/v1/split-beneficiaries"
payload = {
"organizationId": "<string>",
"beneficiaryName": "<string>",
"accountNumber": "<string>",
"bankCode": "<string>",
"bankName": "<string>",
"beneficiaryAlias": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organizationId: '<string>',
beneficiaryName: '<string>',
accountNumber: '<string>',
bankCode: '<string>',
bankName: '<string>',
beneficiaryAlias: '<string>'
})
};
fetch('https://checkout-staging.embedly.ng/api/v1/split-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://checkout-staging.embedly.ng/api/v1/split-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([
'organizationId' => '<string>',
'beneficiaryName' => '<string>',
'accountNumber' => '<string>',
'bankCode' => '<string>',
'bankName' => '<string>',
'beneficiaryAlias' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries"
payload := strings.NewReader("{\n \"organizationId\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"bankName\": \"<string>\",\n \"beneficiaryAlias\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-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://checkout-staging.embedly.ng/api/v1/split-beneficiaries")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organizationId\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"bankName\": \"<string>\",\n \"beneficiaryAlias\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://checkout-staging.embedly.ng/api/v1/split-beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organizationId\": \"<string>\",\n \"beneficiaryName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"bankName\": \"<string>\",\n \"beneficiaryAlias\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 200,
"message": "Split beneficiary created successfully",
"data": {
"id": "1c7e2c80-9f8c-4bd8-8c9d-bd63810c5df9",
"organizationId": "0075b72d-6648-11f0-a7cf-0274f77d4a81",
"beneficiaryName": "string",
"accountNumber": "4278816938",
"bankCode": "string",
"bankName": "string",
"beneficiaryAlias": "string",
"isActive": true,
"createdAt": "2026-02-16T07:57:04.4688132Z",
"updatedAt": null
}
}
{
"statusCode": 400,
"message": "Validation failed",
"errors": [
"The request field is required.",
"The JSON value could not be converted to System.Guid. Path: $.organizationId | LineNumber: 1 | BytePositionInLine: 60."
],
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
string
required
Example:
02600494-1a3c-11f0-a818-6045bd97b81dstring
required
Example:
John Doestring
required
Example:
7891256098string
Example:
30234.string
Example:
Sterling Bank.string
Example:
Testing.{
"statusCode": 200,
"message": "Split beneficiary created successfully",
"data": {
"id": "1c7e2c80-9f8c-4bd8-8c9d-bd63810c5df9",
"organizationId": "0075b72d-6648-11f0-a7cf-0274f77d4a81",
"beneficiaryName": "string",
"accountNumber": "4278816938",
"bankCode": "string",
"bankName": "string",
"beneficiaryAlias": "string",
"isActive": true,
"createdAt": "2026-02-16T07:57:04.4688132Z",
"updatedAt": null
}
}
{
"statusCode": 400,
"message": "Validation failed",
"errors": [
"The request field is required.",
"The JSON value could not be converted to System.Guid. Path: $.organizationId | LineNumber: 1 | BytePositionInLine: 60."
],
"data": null
}
{
"code": "401",
"success": false,
"message": "x-api-key is missing in the header",
"data": null
}
{
"statusCode": 403,
"message": "Access denied. The API key provided is for another organization. You can only access your organization's wallets.",
"data": null
}
{
"code": "500",
"success": false,
"message": "An unexpected error occurred",
"data": null
}
⌘I