cURL
curl --request POST \
--url https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nickname": "<string>",
"isDefault": true,
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"walletAddress": "<string>",
"chain": "<string>",
"token": "<string>",
"name": "<string>",
"accountType": "<string>",
"network": "<string>"
}
'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries"
payload = {
"nickname": "<string>",
"isDefault": True,
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"walletAddress": "<string>",
"chain": "<string>",
"token": "<string>",
"name": "<string>",
"accountType": "<string>",
"network": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
nickname: '<string>',
isDefault: true,
accountName: '<string>',
accountNumber: '<string>',
bankName: '<string>',
bankCode: '<string>',
walletAddress: '<string>',
chain: '<string>',
token: '<string>',
name: '<string>',
accountType: '<string>',
network: '<string>'
})
};
fetch('https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/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://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/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([
'nickname' => '<string>',
'isDefault' => true,
'accountName' => '<string>',
'accountNumber' => '<string>',
'bankName' => '<string>',
'bankCode' => '<string>',
'walletAddress' => '<string>',
'chain' => '<string>',
'token' => '<string>',
'name' => '<string>',
'accountType' => '<string>',
'network' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries"
payload := strings.NewReader("{\n \"nickname\": \"<string>\",\n \"isDefault\": true,\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"chain\": \"<string>\",\n \"token\": \"<string>\",\n \"name\": \"<string>\",\n \"accountType\": \"<string>\",\n \"network\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"<string>\",\n \"isDefault\": true,\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"chain\": \"<string>\",\n \"token\": \"<string>\",\n \"name\": \"<string>\",\n \"accountType\": \"<string>\",\n \"network\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"<string>\",\n \"isDefault\": true,\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"chain\": \"<string>\",\n \"token\": \"<string>\",\n \"name\": \"<string>\",\n \"accountType\": \"<string>\",\n \"network\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodySaved Beneficiaries
Create Settlement Beneficiary
POST
/
api
/
v3
/
integrator
/
settlement-config
/
beneficiaries
cURL
curl --request POST \
--url https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"nickname": "<string>",
"isDefault": true,
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"walletAddress": "<string>",
"chain": "<string>",
"token": "<string>",
"name": "<string>",
"accountType": "<string>",
"network": "<string>"
}
'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries"
payload = {
"nickname": "<string>",
"isDefault": True,
"accountName": "<string>",
"accountNumber": "<string>",
"bankName": "<string>",
"bankCode": "<string>",
"walletAddress": "<string>",
"chain": "<string>",
"token": "<string>",
"name": "<string>",
"accountType": "<string>",
"network": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
nickname: '<string>',
isDefault: true,
accountName: '<string>',
accountNumber: '<string>',
bankName: '<string>',
bankCode: '<string>',
walletAddress: '<string>',
chain: '<string>',
token: '<string>',
name: '<string>',
accountType: '<string>',
network: '<string>'
})
};
fetch('https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/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://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/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([
'nickname' => '<string>',
'isDefault' => true,
'accountName' => '<string>',
'accountNumber' => '<string>',
'bankName' => '<string>',
'bankCode' => '<string>',
'walletAddress' => '<string>',
'chain' => '<string>',
'token' => '<string>',
'name' => '<string>',
'accountType' => '<string>',
'network' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries"
payload := strings.NewReader("{\n \"nickname\": \"<string>\",\n \"isDefault\": true,\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"chain\": \"<string>\",\n \"token\": \"<string>\",\n \"name\": \"<string>\",\n \"accountType\": \"<string>\",\n \"network\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"nickname\": \"<string>\",\n \"isDefault\": true,\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"chain\": \"<string>\",\n \"token\": \"<string>\",\n \"name\": \"<string>\",\n \"accountType\": \"<string>\",\n \"network\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.io/api/v3/integrator/settlement-config/beneficiaries")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"nickname\": \"<string>\",\n \"isDefault\": true,\n \"accountName\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"bankName\": \"<string>\",\n \"bankCode\": \"<string>\",\n \"walletAddress\": \"<string>\",\n \"chain\": \"<string>\",\n \"token\": \"<string>\",\n \"name\": \"<string>\",\n \"accountType\": \"<string>\",\n \"network\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAdd a new settlement beneficiary for the authenticated integrator.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Human-readable label for this beneficiary
Whether this is the default beneficiary
bank or crypto — determines which fields apply
Available options:
bank, crypto Name on the bank account
Bank account number
Bank name (e.g. Equity Bank)
Bank code / sort code (optional)
Crypto wallet address
Blockchain chain (e.g. Polygon, Tron, BSC)
Token/asset symbol on the chain (e.g. USDT, USDC)
Full name of the beneficiary (display)
Account type: Exchange / Non-Custodial / Bank (legacy)
Network sub-type (legacy — prefer token field for asset)
Response
201 - undefined
⌘I