Preview bulk payment batches
curl --request POST \
--url https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview \
--header 'Content-Type: application/json' \
--data '
{
"batchName": "<string>",
"recipients": [
{
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientPhone": "<string>",
"amount": 123,
"reference": "<string>"
}
],
"walletSelections": [
{
"walletId": "<string>"
}
],
"batchDescription": "<string>",
"callbackUrl": "<string>",
"integratorId": "<string>"
}
'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview"
payload = {
"batchName": "<string>",
"recipients": [
{
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientPhone": "<string>",
"amount": 123,
"reference": "<string>"
}
],
"walletSelections": [{ "walletId": "<string>" }],
"batchDescription": "<string>",
"callbackUrl": "<string>",
"integratorId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
batchName: '<string>',
recipients: [
{
recipientName: '<string>',
recipientEmail: '<string>',
recipientPhone: '<string>',
amount: 123,
reference: '<string>'
}
],
walletSelections: [{walletId: '<string>'}],
batchDescription: '<string>',
callbackUrl: '<string>',
integratorId: '<string>'
})
};
fetch('https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview', 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/dashboard/bulk-payments/api/preview",
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([
'batchName' => '<string>',
'recipients' => [
[
'recipientName' => '<string>',
'recipientEmail' => '<string>',
'recipientPhone' => '<string>',
'amount' => 123,
'reference' => '<string>'
]
],
'walletSelections' => [
[
'walletId' => '<string>'
]
],
'batchDescription' => '<string>',
'callbackUrl' => '<string>',
'integratorId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/dashboard/bulk-payments/api/preview"
payload := strings.NewReader("{\n \"batchName\": \"<string>\",\n \"recipients\": [\n {\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientPhone\": \"<string>\",\n \"amount\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"walletSelections\": [\n {\n \"walletId\": \"<string>\"\n }\n ],\n \"batchDescription\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"integratorId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/dashboard/bulk-payments/api/preview")
.header("Content-Type", "application/json")
.body("{\n \"batchName\": \"<string>\",\n \"recipients\": [\n {\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientPhone\": \"<string>\",\n \"amount\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"walletSelections\": [\n {\n \"walletId\": \"<string>\"\n }\n ],\n \"batchDescription\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"integratorId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"batchName\": \"<string>\",\n \"recipients\": [\n {\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientPhone\": \"<string>\",\n \"amount\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"walletSelections\": [\n {\n \"walletId\": \"<string>\"\n }\n ],\n \"batchDescription\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"integratorId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"totalBatches": 123,
"totalRecipients": 123,
"currencyBreakdown": [
{
"recipientCount": 123,
"totalAmount": 123,
"walletId": "<string>",
"recipients": [
{
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientPhone": "<string>",
"amount": 123,
"reference": "<string>"
}
]
}
]
}Bulk Payments
Preview Bulk Payment Batches
POST
/
api
/
v3
/
dashboard
/
bulk-payments
/
api
/
preview
Preview bulk payment batches
curl --request POST \
--url https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview \
--header 'Content-Type: application/json' \
--data '
{
"batchName": "<string>",
"recipients": [
{
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientPhone": "<string>",
"amount": 123,
"reference": "<string>"
}
],
"walletSelections": [
{
"walletId": "<string>"
}
],
"batchDescription": "<string>",
"callbackUrl": "<string>",
"integratorId": "<string>"
}
'import requests
url = "https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview"
payload = {
"batchName": "<string>",
"recipients": [
{
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientPhone": "<string>",
"amount": 123,
"reference": "<string>"
}
],
"walletSelections": [{ "walletId": "<string>" }],
"batchDescription": "<string>",
"callbackUrl": "<string>",
"integratorId": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
batchName: '<string>',
recipients: [
{
recipientName: '<string>',
recipientEmail: '<string>',
recipientPhone: '<string>',
amount: 123,
reference: '<string>'
}
],
walletSelections: [{walletId: '<string>'}],
batchDescription: '<string>',
callbackUrl: '<string>',
integratorId: '<string>'
})
};
fetch('https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview', 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/dashboard/bulk-payments/api/preview",
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([
'batchName' => '<string>',
'recipients' => [
[
'recipientName' => '<string>',
'recipientEmail' => '<string>',
'recipientPhone' => '<string>',
'amount' => 123,
'reference' => '<string>'
]
],
'walletSelections' => [
[
'walletId' => '<string>'
]
],
'batchDescription' => '<string>',
'callbackUrl' => '<string>',
'integratorId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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/dashboard/bulk-payments/api/preview"
payload := strings.NewReader("{\n \"batchName\": \"<string>\",\n \"recipients\": [\n {\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientPhone\": \"<string>\",\n \"amount\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"walletSelections\": [\n {\n \"walletId\": \"<string>\"\n }\n ],\n \"batchDescription\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"integratorId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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/dashboard/bulk-payments/api/preview")
.header("Content-Type", "application/json")
.body("{\n \"batchName\": \"<string>\",\n \"recipients\": [\n {\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientPhone\": \"<string>\",\n \"amount\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"walletSelections\": [\n {\n \"walletId\": \"<string>\"\n }\n ],\n \"batchDescription\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"integratorId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.kotanipay.io/api/v3/dashboard/bulk-payments/api/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"batchName\": \"<string>\",\n \"recipients\": [\n {\n \"recipientName\": \"<string>\",\n \"recipientEmail\": \"<string>\",\n \"recipientPhone\": \"<string>\",\n \"amount\": 123,\n \"reference\": \"<string>\"\n }\n ],\n \"walletSelections\": [\n {\n \"walletId\": \"<string>\"\n }\n ],\n \"batchDescription\": \"<string>\",\n \"callbackUrl\": \"<string>\",\n \"integratorId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"totalBatches": 123,
"totalRecipients": 123,
"currencyBreakdown": [
{
"recipientCount": 123,
"totalAmount": 123,
"walletId": "<string>",
"recipients": [
{
"recipientName": "<string>",
"recipientEmail": "<string>",
"recipientPhone": "<string>",
"amount": 123,
"reference": "<string>"
}
]
}
]
}Preview bulk payment batches before creating them to review fees and totals.
Body
application/json
Batch name
Recipients list
Show child attributes
Show child attributes
Currency wallet selections
Show child attributes
Show child attributes
Batch description
Callback URL for notifications
For admin use - integrator ID
Response
200 - application/json
Preview of bulk payment batch
⌘I