Payout
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"amount": "Provide amount",
"source": {
"account_number": "Provide source account number"
},
"beneficiary": {
"bank_code": "Provide bank code",
"bank_name": "Provide bank name",
"account_number": "Provide account number",
"account_name": "Provide account name"
},
"reference": "Provide reference",
"meta_data": {},
"remark": "Provide remark"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 'Provide amount',
source: {account_number: 'Provide source account number'},
beneficiary: {
bank_code: 'Provide bank code',
bank_name: 'Provide bank name',
account_number: 'Provide account number',
account_name: 'Provide account name'
},
reference: 'Provide reference',
meta_data: {},
remark: 'Provide remark'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/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://carbonapistagingsecure.getcarbon.co/baas/api/v1/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([
'amount' => 'Provide amount',
'source' => [
'account_number' => 'Provide source account number'
],
'beneficiary' => [
'bank_code' => 'Provide bank code',
'bank_name' => 'Provide bank name',
'account_number' => 'Provide account number',
'account_name' => 'Provide account name'
],
'reference' => 'Provide reference',
'meta_data' => [
],
'remark' => 'Provide remark'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts"
payload = {
"amount": "Provide amount",
"source": { "account_number": "Provide source account number" },
"beneficiary": {
"bank_code": "Provide bank code",
"bank_name": "Provide bank name",
"account_number": "Provide account number",
"account_name": "Provide account name"
},
"reference": "Provide reference",
"meta_data": {},
"remark": "Provide remark"
}
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"Provide amount\",\n \"source\": {\n \"account_number\": \"Provide source account number\"\n },\n \"beneficiary\": {\n \"bank_code\": \"Provide bank code\",\n \"bank_name\": \"Provide bank name\",\n \"account_number\": \"Provide account number\",\n \"account_name\": \"Provide account name\"\n },\n \"reference\": \"Provide reference\",\n \"meta_data\": {},\n \"remark\": \"Provide remark\"\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts"
payload := strings.NewReader("{\n \"amount\": \"Provide amount\",\n \"source\": {\n \"account_number\": \"Provide source account number\"\n },\n \"beneficiary\": {\n \"bank_code\": \"Provide bank code\",\n \"bank_name\": \"Provide bank name\",\n \"account_number\": \"Provide account number\",\n \"account_name\": \"Provide account name\"\n },\n \"reference\": \"Provide reference\",\n \"meta_data\": {},\n \"remark\": \"Provide remark\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<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))
}{
"status": "success",
"message": "payout was initiated successfully",
"data": {
"amount": 150,
"total": 175,
"fee": 25,
"reference": "204041344312337",
"beneficiary": {
"bank_code": "057",
"bank_name": "Dummy Bank",
"account_number": "32324546565",
"account_name": "Test User"
}
}
}Payouts
Create Payout
Initiate a payout to a beneficiary account.
POST
/
v1
/
payouts
Payout
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"amount": "Provide amount",
"source": {
"account_number": "Provide source account number"
},
"beneficiary": {
"bank_code": "Provide bank code",
"bank_name": "Provide bank name",
"account_number": "Provide account number",
"account_name": "Provide account name"
},
"reference": "Provide reference",
"meta_data": {},
"remark": "Provide remark"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 'Provide amount',
source: {account_number: 'Provide source account number'},
beneficiary: {
bank_code: 'Provide bank code',
bank_name: 'Provide bank name',
account_number: 'Provide account number',
account_name: 'Provide account name'
},
reference: 'Provide reference',
meta_data: {},
remark: 'Provide remark'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/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://carbonapistagingsecure.getcarbon.co/baas/api/v1/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([
'amount' => 'Provide amount',
'source' => [
'account_number' => 'Provide source account number'
],
'beneficiary' => [
'bank_code' => 'Provide bank code',
'bank_name' => 'Provide bank name',
'account_number' => 'Provide account number',
'account_name' => 'Provide account name'
],
'reference' => 'Provide reference',
'meta_data' => [
],
'remark' => 'Provide remark'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"apikey: <api-key>",
"x-carbon-key: <x-carbon-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}import requests
url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts"
payload = {
"amount": "Provide amount",
"source": { "account_number": "Provide source account number" },
"beneficiary": {
"bank_code": "Provide bank code",
"bank_name": "Provide bank name",
"account_number": "Provide account number",
"account_name": "Provide account name"
},
"reference": "Provide reference",
"meta_data": {},
"remark": "Provide remark"
}
headers = {
"x-carbon-key": "<x-carbon-key>",
"apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"Provide amount\",\n \"source\": {\n \"account_number\": \"Provide source account number\"\n },\n \"beneficiary\": {\n \"bank_code\": \"Provide bank code\",\n \"bank_name\": \"Provide bank name\",\n \"account_number\": \"Provide account number\",\n \"account_name\": \"Provide account name\"\n },\n \"reference\": \"Provide reference\",\n \"meta_data\": {},\n \"remark\": \"Provide remark\"\n}"
response = http.request(request)
puts response.read_bodypackage main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts"
payload := strings.NewReader("{\n \"amount\": \"Provide amount\",\n \"source\": {\n \"account_number\": \"Provide source account number\"\n },\n \"beneficiary\": {\n \"bank_code\": \"Provide bank code\",\n \"bank_name\": \"Provide bank name\",\n \"account_number\": \"Provide account number\",\n \"account_name\": \"Provide account name\"\n },\n \"reference\": \"Provide reference\",\n \"meta_data\": {},\n \"remark\": \"Provide remark\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-carbon-key", "<x-carbon-key>")
req.Header.Add("apikey", "<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))
}{
"status": "success",
"message": "payout was initiated successfully",
"data": {
"amount": 150,
"total": 175,
"fee": 25,
"reference": "204041344312337",
"beneficiary": {
"bank_code": "057",
"bank_name": "Dummy Bank",
"account_number": "32324546565",
"account_name": "Test User"
}
}
}Overview
This endpoint allows you to initiate a payout to a beneficiary account by providing the necessary details such as amount, source account, and beneficiary information.Before creating a payout, you must validate the beneficiary bank account using the Resolve Account endpoint to ensure the account details are correct.
The minimum payout amount is ₦200.
Request
Method:POSTURL:
/v1/payouts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
x-carbon-key | Header | string | Yes | API key for authentication. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Amount to be paid out in kobo (minimum: 20000 = ₦200) |
source.account_number | string | Yes | Source account number for the payout |
beneficiary.bank_code | string | Yes | Bank code of the beneficiary’s bank |
beneficiary.bank_name | string | Yes | Name of the beneficiary’s bank |
beneficiary.account_number | string | Yes | Beneficiary’s account number (must be validated using /api-reference/banks/resolve-account) |
beneficiary.account_name | string | Yes | Beneficiary’s account name (obtained from resolve account response) |
reference | string | Yes | Unique reference for this payout request (max 30 characters) |
meta_data | object | No | Additional metadata for the transaction |
remark | string | Yes | Description or note for the payout |
The
reference field must be unique for each new payout request. Using a duplicate reference will result in an error.PAYOUT_USER123_20260119PAY_INV_456789SALARY_EMP001_JAN26
{
"amount": 15000,
"source": {
"account_number": "1234567890"
},
"beneficiary": {
"bank_code": "565",
"bank_name": "CARBON",
"account_number": "9876543210",
"account_name": "John Doe"
},
"reference": "PAYOUT_USER123_20260119",
"meta_data": {},
"remark": "Payment for services"
}
Response
Status Code:200 OKContent-Type:
application/json
Example Response
{
"status": "success",
"message": "Payout was initiated successfully",
"data": {
"amount": 15000,
"total": 15000,
"fee": 0,
"reference": "PAYOUT_USER123_20260119",
"beneficiary": {
"bank_code": "565",
"bank_name": "CARBON",
"account_number": "9876543210",
"account_name": "John Doe"
}
}
}
Authorizations
Provide your API key in the 'apikey' header.
Headers
Body
application/json
Provide the required values for the request body.
Response
200 - application/json
OK
The response is of type object.
⌘I