Create a bulk payout
curl --request POST \
--url https://api.dfolt.com/v1/bulk-payouts \
--header 'Accept: <accept>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"connection_id": "<string>",
"currency": "<string>",
"records": [
{
"amount": 123,
"beneficiary_iban": "<string>",
"beneficiary_name": "<string>",
"value_date": "<string>",
"beneficiary_address_1": "<string>",
"beneficiary_address_2": "<string>",
"debit_account": "<string>",
"debtor_address_1": "<string>",
"debtor_address_2": "<string>",
"debtor_address_3": "<string>",
"debtor_name": "<string>",
"narrative": "<string>",
"purpose_code": "<string>"
}
],
"multi_debit": true
}
'import requests
url = "https://api.dfolt.com/v1/bulk-payouts"
payload = {
"connection_id": "<string>",
"currency": "<string>",
"records": [
{
"amount": 123,
"beneficiary_iban": "<string>",
"beneficiary_name": "<string>",
"value_date": "<string>",
"beneficiary_address_1": "<string>",
"beneficiary_address_2": "<string>",
"debit_account": "<string>",
"debtor_address_1": "<string>",
"debtor_address_2": "<string>",
"debtor_address_3": "<string>",
"debtor_name": "<string>",
"narrative": "<string>",
"purpose_code": "<string>"
}
],
"multi_debit": True
}
headers = {
"Accept": "<accept>",
"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: {
Accept: '<accept>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
connection_id: '<string>',
currency: '<string>',
records: [
{
amount: 123,
beneficiary_iban: '<string>',
beneficiary_name: '<string>',
value_date: '<string>',
beneficiary_address_1: '<string>',
beneficiary_address_2: '<string>',
debit_account: '<string>',
debtor_address_1: '<string>',
debtor_address_2: '<string>',
debtor_address_3: '<string>',
debtor_name: '<string>',
narrative: '<string>',
purpose_code: '<string>'
}
],
multi_debit: true
})
};
fetch('https://api.dfolt.com/v1/bulk-payouts', 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.dfolt.com/v1/bulk-payouts",
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([
'connection_id' => '<string>',
'currency' => '<string>',
'records' => [
[
'amount' => 123,
'beneficiary_iban' => '<string>',
'beneficiary_name' => '<string>',
'value_date' => '<string>',
'beneficiary_address_1' => '<string>',
'beneficiary_address_2' => '<string>',
'debit_account' => '<string>',
'debtor_address_1' => '<string>',
'debtor_address_2' => '<string>',
'debtor_address_3' => '<string>',
'debtor_name' => '<string>',
'narrative' => '<string>',
'purpose_code' => '<string>'
]
],
'multi_debit' => true
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"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://api.dfolt.com/v1/bulk-payouts"
payload := strings.NewReader("{\n \"connection_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"records\": [\n {\n \"amount\": 123,\n \"beneficiary_iban\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"value_date\": \"<string>\",\n \"beneficiary_address_1\": \"<string>\",\n \"beneficiary_address_2\": \"<string>\",\n \"debit_account\": \"<string>\",\n \"debtor_address_1\": \"<string>\",\n \"debtor_address_2\": \"<string>\",\n \"debtor_address_3\": \"<string>\",\n \"debtor_name\": \"<string>\",\n \"narrative\": \"<string>\",\n \"purpose_code\": \"<string>\"\n }\n ],\n \"multi_debit\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Accept", "<accept>")
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://api.dfolt.com/v1/bulk-payouts")
.header("Accept", "<accept>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"records\": [\n {\n \"amount\": 123,\n \"beneficiary_iban\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"value_date\": \"<string>\",\n \"beneficiary_address_1\": \"<string>\",\n \"beneficiary_address_2\": \"<string>\",\n \"debit_account\": \"<string>\",\n \"debtor_address_1\": \"<string>\",\n \"debtor_address_2\": \"<string>\",\n \"debtor_address_3\": \"<string>\",\n \"debtor_name\": \"<string>\",\n \"narrative\": \"<string>\",\n \"purpose_code\": \"<string>\"\n }\n ],\n \"multi_debit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dfolt.com/v1/bulk-payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"records\": [\n {\n \"amount\": 123,\n \"beneficiary_iban\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"value_date\": \"<string>\",\n \"beneficiary_address_1\": \"<string>\",\n \"beneficiary_address_2\": \"<string>\",\n \"debit_account\": \"<string>\",\n \"debtor_address_1\": \"<string>\",\n \"debtor_address_2\": \"<string>\",\n \"debtor_address_3\": \"<string>\",\n \"debtor_name\": \"<string>\",\n \"narrative\": \"<string>\",\n \"purpose_code\": \"<string>\"\n }\n ],\n \"multi_debit\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"reference_id": "<string>",
"status": "<string>",
"transaction_type": "<string>",
"trn": "<string>"
},
"debug_id": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}Bulk Payouts
Create a bulk payout
Creates a bulk payout from JSON records; bank submission happens after approval
POST
/
v1
/
bulk-payouts
Create a bulk payout
curl --request POST \
--url https://api.dfolt.com/v1/bulk-payouts \
--header 'Accept: <accept>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"connection_id": "<string>",
"currency": "<string>",
"records": [
{
"amount": 123,
"beneficiary_iban": "<string>",
"beneficiary_name": "<string>",
"value_date": "<string>",
"beneficiary_address_1": "<string>",
"beneficiary_address_2": "<string>",
"debit_account": "<string>",
"debtor_address_1": "<string>",
"debtor_address_2": "<string>",
"debtor_address_3": "<string>",
"debtor_name": "<string>",
"narrative": "<string>",
"purpose_code": "<string>"
}
],
"multi_debit": true
}
'import requests
url = "https://api.dfolt.com/v1/bulk-payouts"
payload = {
"connection_id": "<string>",
"currency": "<string>",
"records": [
{
"amount": 123,
"beneficiary_iban": "<string>",
"beneficiary_name": "<string>",
"value_date": "<string>",
"beneficiary_address_1": "<string>",
"beneficiary_address_2": "<string>",
"debit_account": "<string>",
"debtor_address_1": "<string>",
"debtor_address_2": "<string>",
"debtor_address_3": "<string>",
"debtor_name": "<string>",
"narrative": "<string>",
"purpose_code": "<string>"
}
],
"multi_debit": True
}
headers = {
"Accept": "<accept>",
"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: {
Accept: '<accept>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
connection_id: '<string>',
currency: '<string>',
records: [
{
amount: 123,
beneficiary_iban: '<string>',
beneficiary_name: '<string>',
value_date: '<string>',
beneficiary_address_1: '<string>',
beneficiary_address_2: '<string>',
debit_account: '<string>',
debtor_address_1: '<string>',
debtor_address_2: '<string>',
debtor_address_3: '<string>',
debtor_name: '<string>',
narrative: '<string>',
purpose_code: '<string>'
}
],
multi_debit: true
})
};
fetch('https://api.dfolt.com/v1/bulk-payouts', 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.dfolt.com/v1/bulk-payouts",
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([
'connection_id' => '<string>',
'currency' => '<string>',
'records' => [
[
'amount' => 123,
'beneficiary_iban' => '<string>',
'beneficiary_name' => '<string>',
'value_date' => '<string>',
'beneficiary_address_1' => '<string>',
'beneficiary_address_2' => '<string>',
'debit_account' => '<string>',
'debtor_address_1' => '<string>',
'debtor_address_2' => '<string>',
'debtor_address_3' => '<string>',
'debtor_name' => '<string>',
'narrative' => '<string>',
'purpose_code' => '<string>'
]
],
'multi_debit' => true
]),
CURLOPT_HTTPHEADER => [
"Accept: <accept>",
"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://api.dfolt.com/v1/bulk-payouts"
payload := strings.NewReader("{\n \"connection_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"records\": [\n {\n \"amount\": 123,\n \"beneficiary_iban\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"value_date\": \"<string>\",\n \"beneficiary_address_1\": \"<string>\",\n \"beneficiary_address_2\": \"<string>\",\n \"debit_account\": \"<string>\",\n \"debtor_address_1\": \"<string>\",\n \"debtor_address_2\": \"<string>\",\n \"debtor_address_3\": \"<string>\",\n \"debtor_name\": \"<string>\",\n \"narrative\": \"<string>\",\n \"purpose_code\": \"<string>\"\n }\n ],\n \"multi_debit\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Accept", "<accept>")
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://api.dfolt.com/v1/bulk-payouts")
.header("Accept", "<accept>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"connection_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"records\": [\n {\n \"amount\": 123,\n \"beneficiary_iban\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"value_date\": \"<string>\",\n \"beneficiary_address_1\": \"<string>\",\n \"beneficiary_address_2\": \"<string>\",\n \"debit_account\": \"<string>\",\n \"debtor_address_1\": \"<string>\",\n \"debtor_address_2\": \"<string>\",\n \"debtor_address_3\": \"<string>\",\n \"debtor_name\": \"<string>\",\n \"narrative\": \"<string>\",\n \"purpose_code\": \"<string>\"\n }\n ],\n \"multi_debit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dfolt.com/v1/bulk-payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = '<accept>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"connection_id\": \"<string>\",\n \"currency\": \"<string>\",\n \"records\": [\n {\n \"amount\": 123,\n \"beneficiary_iban\": \"<string>\",\n \"beneficiary_name\": \"<string>\",\n \"value_date\": \"<string>\",\n \"beneficiary_address_1\": \"<string>\",\n \"beneficiary_address_2\": \"<string>\",\n \"debit_account\": \"<string>\",\n \"debtor_address_1\": \"<string>\",\n \"debtor_address_2\": \"<string>\",\n \"debtor_address_3\": \"<string>\",\n \"debtor_name\": \"<string>\",\n \"narrative\": \"<string>\",\n \"purpose_code\": \"<string>\"\n }\n ],\n \"multi_debit\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"reference_id": "<string>",
"status": "<string>",
"transaction_type": "<string>",
"trn": "<string>"
},
"debug_id": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}{
"code": 123,
"debug_id": "<string>",
"error": true,
"fields": {},
"message": "<string>"
}Headers
Body
application/json
Bulk payout details