Bulk payout
curl --request POST \
--url https://sandbox.api.payvehq.com/v1/payouts/bulk \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"items": [
{
"amount": 100000,
"beneficiary": {
"country": "NG",
"accountNumber": "<string>",
"bankCode": "<string>",
"mobileNumber": "<string>",
"holderName": "<string>"
},
"merchantReference": "<string>",
"quoteId": "<string>",
"narration": "<string>",
"metadata": {},
"idempotencyKey": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
amount: 100000,
beneficiary: {
country: 'NG',
accountNumber: '<string>',
bankCode: '<string>',
mobileNumber: '<string>',
holderName: '<string>'
},
merchantReference: '<string>',
quoteId: '<string>',
narration: '<string>',
metadata: {},
idempotencyKey: '<string>'
}
]
})
};
fetch('https://sandbox.api.payvehq.com/v1/payouts/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sandbox.api.payvehq.com/v1/payouts/bulk"
payload = { "items": [
{
"amount": 100000,
"beneficiary": {
"country": "NG",
"accountNumber": "<string>",
"bankCode": "<string>",
"mobileNumber": "<string>",
"holderName": "<string>"
},
"merchantReference": "<string>",
"quoteId": "<string>",
"narration": "<string>",
"metadata": {},
"idempotencyKey": "<string>"
}
] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.payvehq.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([
'items' => [
[
'amount' => 100000,
'beneficiary' => [
'country' => 'NG',
'accountNumber' => '<string>',
'bankCode' => '<string>',
'mobileNumber' => '<string>',
'holderName' => '<string>'
],
'merchantReference' => '<string>',
'quoteId' => '<string>',
'narration' => '<string>',
'metadata' => [
],
'idempotencyKey' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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;
}Payouts
Bulk payout
Send up to 100 payouts in one request. Each row succeeds or fails on its own, and one idempotency key covers the whole batch.
POST
/
v1
/
payouts
/
bulk
Bulk payout
curl --request POST \
--url https://sandbox.api.payvehq.com/v1/payouts/bulk \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"items": [
{
"amount": 100000,
"beneficiary": {
"country": "NG",
"accountNumber": "<string>",
"bankCode": "<string>",
"mobileNumber": "<string>",
"holderName": "<string>"
},
"merchantReference": "<string>",
"quoteId": "<string>",
"narration": "<string>",
"metadata": {},
"idempotencyKey": "<string>"
}
]
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
items: [
{
amount: 100000,
beneficiary: {
country: 'NG',
accountNumber: '<string>',
bankCode: '<string>',
mobileNumber: '<string>',
holderName: '<string>'
},
merchantReference: '<string>',
quoteId: '<string>',
narration: '<string>',
metadata: {},
idempotencyKey: '<string>'
}
]
})
};
fetch('https://sandbox.api.payvehq.com/v1/payouts/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://sandbox.api.payvehq.com/v1/payouts/bulk"
payload = { "items": [
{
"amount": 100000,
"beneficiary": {
"country": "NG",
"accountNumber": "<string>",
"bankCode": "<string>",
"mobileNumber": "<string>",
"holderName": "<string>"
},
"merchantReference": "<string>",
"quoteId": "<string>",
"narration": "<string>",
"metadata": {},
"idempotencyKey": "<string>"
}
] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.api.payvehq.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([
'items' => [
[
'amount' => 100000,
'beneficiary' => [
'country' => 'NG',
'accountNumber' => '<string>',
'bankCode' => '<string>',
'mobileNumber' => '<string>',
'holderName' => '<string>'
],
'merchantReference' => '<string>',
'quoteId' => '<string>',
'narration' => '<string>',
'metadata' => [
],
'idempotencyKey' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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;
}
