Payouts
Bulk-create Payouts
Creates one Payout per row through the single-payout write-path, tagged via { channel: 'csv', uploadId }. Row failures (bad shape, gate rejections) are reported per row and never abort the file. Idempotent by construction: each row's key derives from `${uploadId}:${index}`, so a byte-identical re-upload replays every row instead of duplicating.
POST
/
v1
/
payouts
/
bulk
Bulk-create Payout Intents from CSV rows
curl --request POST \
--url https://api.example.com/v1/payouts/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"uploadId": "<string>",
"rows": [
{
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": 123,
"currency": "<string>",
"external_ref": "<string>",
"idempotency_key": "<string>"
}
]
}
'import requests
url = "https://api.example.com/v1/payouts/bulk"
payload = {
"uploadId": "<string>",
"rows": [
{
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": 123,
"currency": "<string>",
"external_ref": "<string>",
"idempotency_key": "<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({
uploadId: '<string>',
rows: [
{
beneficiary_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bank_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount_minor: 123,
currency: '<string>',
external_ref: '<string>',
idempotency_key: '<string>'
}
]
})
};
fetch('https://api.example.com/v1/payouts/bulk', 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.example.com/v1/payouts/bulk",
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([
'uploadId' => '<string>',
'rows' => [
[
'beneficiary_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bank_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount_minor' => 123,
'currency' => '<string>',
'external_ref' => '<string>',
'idempotency_key' => '<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://api.example.com/v1/payouts/bulk"
payload := strings.NewReader("{\n \"uploadId\": \"<string>\",\n \"rows\": [\n {\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount_minor\": 123,\n \"currency\": \"<string>\",\n \"external_ref\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n }\n ]\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://api.example.com/v1/payouts/bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"uploadId\": \"<string>\",\n \"rows\": [\n {\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount_minor\": 123,\n \"currency\": \"<string>\",\n \"external_ref\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/payouts/bulk")
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 \"uploadId\": \"<string>\",\n \"rows\": [\n {\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount_minor\": 123,\n \"currency\": \"<string>\",\n \"external_ref\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"status": "created",
"payout_id": {},
"error": {}
}
]
}Authorizations
Cleff API key issued to a Business that self-registers via POST /v1/registration
Body
application/json
Content hash of the uploaded file, computed client-side. Tags every Payout's via and seeds each row's idempotency key so a byte-identical re-upload replays instead of duplicating.
Parsed CSV rows (1..1000). Each row is validated individually server-side; a bad row fails only itself.
Show child attributes
Show child attributes
Response
Show child attributes
Show child attributes
⌘I
Bulk-create Payout Intents from CSV rows
curl --request POST \
--url https://api.example.com/v1/payouts/bulk \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"uploadId": "<string>",
"rows": [
{
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": 123,
"currency": "<string>",
"external_ref": "<string>",
"idempotency_key": "<string>"
}
]
}
'import requests
url = "https://api.example.com/v1/payouts/bulk"
payload = {
"uploadId": "<string>",
"rows": [
{
"beneficiary_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"amount_minor": 123,
"currency": "<string>",
"external_ref": "<string>",
"idempotency_key": "<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({
uploadId: '<string>',
rows: [
{
beneficiary_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bank_account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
amount_minor: 123,
currency: '<string>',
external_ref: '<string>',
idempotency_key: '<string>'
}
]
})
};
fetch('https://api.example.com/v1/payouts/bulk', 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.example.com/v1/payouts/bulk",
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([
'uploadId' => '<string>',
'rows' => [
[
'beneficiary_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bank_account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'amount_minor' => 123,
'currency' => '<string>',
'external_ref' => '<string>',
'idempotency_key' => '<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://api.example.com/v1/payouts/bulk"
payload := strings.NewReader("{\n \"uploadId\": \"<string>\",\n \"rows\": [\n {\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount_minor\": 123,\n \"currency\": \"<string>\",\n \"external_ref\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n }\n ]\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://api.example.com/v1/payouts/bulk")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"uploadId\": \"<string>\",\n \"rows\": [\n {\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount_minor\": 123,\n \"currency\": \"<string>\",\n \"external_ref\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/payouts/bulk")
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 \"uploadId\": \"<string>\",\n \"rows\": [\n {\n \"beneficiary_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"amount_minor\": 123,\n \"currency\": \"<string>\",\n \"external_ref\": \"<string>\",\n \"idempotency_key\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"index": 123,
"status": "created",
"payout_id": {},
"error": {}
}
]
}