Initiate Payout
curl --request POST \
--url http://localhost:3050/api/v1/business/open/payouts \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"currency": "ngn",
"beneficiary_uuid": "",
"payout_method_uuid": "",
"amount": "",
"description": "owambe",
"reference": "<string>"
}
'import requests
url = "http://localhost:3050/api/v1/business/open/payouts"
payload = {
"currency": "ngn",
"beneficiary_uuid": "",
"payout_method_uuid": "",
"amount": "",
"description": "owambe",
"reference": "<string>"
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: 'ngn',
beneficiary_uuid: '',
payout_method_uuid: '',
amount: '',
description: 'owambe',
reference: '<string>'
})
};
fetch('http://localhost:3050/api/v1/business/open/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_PORT => "3050",
CURLOPT_URL => "http://localhost:3050/api/v1/business/open/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([
'currency' => 'ngn',
'beneficiary_uuid' => '',
'payout_method_uuid' => '',
'amount' => '',
'description' => 'owambe',
'reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <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 := "http://localhost:3050/api/v1/business/open/payouts"
payload := strings.NewReader("{\n \"currency\": \"ngn\",\n \"beneficiary_uuid\": \"\",\n \"payout_method_uuid\": \"\",\n \"amount\": \"\",\n \"description\": \"owambe\",\n \"reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<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("http://localhost:3050/api/v1/business/open/payouts")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"ngn\",\n \"beneficiary_uuid\": \"\",\n \"payout_method_uuid\": \"\",\n \"amount\": \"\",\n \"description\": \"owambe\",\n \"reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3050/api/v1/business/open/payouts")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"ngn\",\n \"beneficiary_uuid\": \"\",\n \"payout_method_uuid\": \"\",\n \"amount\": \"\",\n \"description\": \"owambe\",\n \"reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPayout
Initiate Payout
POST
/
api
/
v1
/
business
/
open
/
payouts
Initiate Payout
curl --request POST \
--url http://localhost:3050/api/v1/business/open/payouts \
--header 'Content-Type: application/json' \
--header 'authorization: <api-key>' \
--data '
{
"currency": "ngn",
"beneficiary_uuid": "",
"payout_method_uuid": "",
"amount": "",
"description": "owambe",
"reference": "<string>"
}
'import requests
url = "http://localhost:3050/api/v1/business/open/payouts"
payload = {
"currency": "ngn",
"beneficiary_uuid": "",
"payout_method_uuid": "",
"amount": "",
"description": "owambe",
"reference": "<string>"
}
headers = {
"authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
currency: 'ngn',
beneficiary_uuid: '',
payout_method_uuid: '',
amount: '',
description: 'owambe',
reference: '<string>'
})
};
fetch('http://localhost:3050/api/v1/business/open/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_PORT => "3050",
CURLOPT_URL => "http://localhost:3050/api/v1/business/open/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([
'currency' => 'ngn',
'beneficiary_uuid' => '',
'payout_method_uuid' => '',
'amount' => '',
'description' => 'owambe',
'reference' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"authorization: <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 := "http://localhost:3050/api/v1/business/open/payouts"
payload := strings.NewReader("{\n \"currency\": \"ngn\",\n \"beneficiary_uuid\": \"\",\n \"payout_method_uuid\": \"\",\n \"amount\": \"\",\n \"description\": \"owambe\",\n \"reference\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "<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("http://localhost:3050/api/v1/business/open/payouts")
.header("authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"currency\": \"ngn\",\n \"beneficiary_uuid\": \"\",\n \"payout_method_uuid\": \"\",\n \"amount\": \"\",\n \"description\": \"owambe\",\n \"reference\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3050/api/v1/business/open/payouts")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"currency\": \"ngn\",\n \"beneficiary_uuid\": \"\",\n \"payout_method_uuid\": \"\",\n \"amount\": \"\",\n \"description\": \"owambe\",\n \"reference\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Body
application/json
The currency
Available options:
usd, ngn, ghs, eur, gbp, kes, zar, ugx, tzs, xof, rwf, zmw, xaf, gmd, lrd, mwk, etb, egp, sle, usdt, usdc, btc, eth, sol, trx, local_currency Example:
"ngn"
The uuid of the customer's beneficiary
Example:
""
The uuid of the payout method
Example:
""
The amount to payout
Required range:
x >= 0.01Example:
""
The description
Example:
"owambe"
Your reference
Response
201

