Merchant Fee Charge
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts/merchant-fee-charge \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"amount": 10,
"description": "Fee Charge of N100",
"sourceAccountId": "0340899287",
"targetAccountId": "6009490194"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 10,
description: 'Fee Charge of N100',
sourceAccountId: '0340899287',
targetAccountId: '6009490194'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts/merchant-fee-charge', 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/merchant-fee-charge",
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' => 10,
'description' => 'Fee Charge of N100',
'sourceAccountId' => '0340899287',
'targetAccountId' => '6009490194'
]),
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/merchant-fee-charge"
payload = {
"amount": 10,
"description": "Fee Charge of N100",
"sourceAccountId": "0340899287",
"targetAccountId": "6009490194"
}
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/merchant-fee-charge")
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\": 10,\n \"description\": \"Fee Charge of N100\",\n \"sourceAccountId\": \"0340899287\",\n \"targetAccountId\": \"6009490194\"\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/merchant-fee-charge"
payload := strings.NewReader("{\n \"amount\": 10,\n \"description\": \"Fee Charge of N100\",\n \"sourceAccountId\": \"0340899287\",\n \"targetAccountId\": \"6009490194\"\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": "Merchant fee charge processed successful...",
"data": {
"success": true,
"message": "Successful",
"statusCode": "00",
"transaction": {
"wasReversed": false,
"amount": 1000,
"description": "Fee Charge of N100",
"category": "Fund Transfer",
"uniqueRef": "177383661255062352",
"internalRef": "1406812",
"transactionType": "DEBIT",
"entryDate": "2026-03-18T12:23:41.015+0000",
"internal": true,
"accountId": "0340899287"
}
}
}{
"status": "failed",
"message": "invalid source account"
}Payouts
Merchant Fee Charge
Process a merchant fee charge by debiting a source account and crediting a target account.
POST
/
v1
/
payouts
/
merchant-fee-charge
Merchant Fee Charge
curl --request POST \
--url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts/merchant-fee-charge \
--header 'Content-Type: application/json' \
--header 'apikey: <api-key>' \
--header 'x-carbon-key: <x-carbon-key>' \
--data '
{
"amount": 10,
"description": "Fee Charge of N100",
"sourceAccountId": "0340899287",
"targetAccountId": "6009490194"
}
'const options = {
method: 'POST',
headers: {
'x-carbon-key': '<x-carbon-key>',
apikey: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 10,
description: 'Fee Charge of N100',
sourceAccountId: '0340899287',
targetAccountId: '6009490194'
})
};
fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/payouts/merchant-fee-charge', 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/merchant-fee-charge",
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' => 10,
'description' => 'Fee Charge of N100',
'sourceAccountId' => '0340899287',
'targetAccountId' => '6009490194'
]),
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/merchant-fee-charge"
payload = {
"amount": 10,
"description": "Fee Charge of N100",
"sourceAccountId": "0340899287",
"targetAccountId": "6009490194"
}
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/merchant-fee-charge")
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\": 10,\n \"description\": \"Fee Charge of N100\",\n \"sourceAccountId\": \"0340899287\",\n \"targetAccountId\": \"6009490194\"\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/merchant-fee-charge"
payload := strings.NewReader("{\n \"amount\": 10,\n \"description\": \"Fee Charge of N100\",\n \"sourceAccountId\": \"0340899287\",\n \"targetAccountId\": \"6009490194\"\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": "Merchant fee charge processed successful...",
"data": {
"success": true,
"message": "Successful",
"statusCode": "00",
"transaction": {
"wasReversed": false,
"amount": 1000,
"description": "Fee Charge of N100",
"category": "Fund Transfer",
"uniqueRef": "177383661255062352",
"internalRef": "1406812",
"transactionType": "DEBIT",
"entryDate": "2026-03-18T12:23:41.015+0000",
"internal": true,
"accountId": "0340899287"
}
}
}{
"status": "failed",
"message": "invalid source account"
}Overview
This endpoint processes a merchant fee charge by debiting a source account and crediting a target account for the specified amount.Request
Method:POST
URL: /v1/payouts/merchant-fee-charge
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 in Naira. Must be a positive value. |
sourceAccountId | string | Yes | Source account number to be debited. |
targetAccountId | string | Yes | Target account number to be credited. |
description | string | No | Optional narration/description for the fee charge. |
{
"amount": 10,
"description": "Fee Charge of N100",
"sourceAccountId": "0340899287",
"targetAccountId": "6009490194"
}
Response
Status Code:201 Created
Content-Type: application/json
Example Response
{
"status": "success",
"message": "Merchant fee charge processed successful...",
"data": {
"success": true,
"message": "Successful",
"statusCode": "00",
"transaction": {
"wasReversed": false,
"amount": 1000,
"description": "Fee Charge of N100",
"category": "Fund Transfer",
"uniqueRef": "177383661255062352",
"internalRef": "1406812",
"transactionType": "DEBIT",
"entryDate": "2026-03-18T12:23:41.015+0000",
"internal": true,
"accountId": "0340899287"
}
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
status | string | Overall request status (success) |
message | string | Human-readable result message |
data.success | boolean | Whether the fee charge was processed successfully |
data.statusCode | string | Business status code (00 = success) |
data.transaction.uniqueRef | string | Unique transaction reference for reconciliation |
data.transaction.internalRef | string | Internal reference for support lookups |
data.transaction.amount | number | Amount processed (in kobo) |
data.transaction.transactionType | string | Direction of the transaction (DEBIT) |
data.transaction.accountId | string | The source account that was debited |
data.statusCode: "00" indicates a successful transaction. Use data.transaction.uniqueRef and data.transaction.internalRef for reconciliation and support.Error Responses
Status Code:400 Bad Request
A 400 response indicates the request was invalid — for example, missing required fields, invalid account identifiers, or an invalid amount.
{
"status": "failed",
"message": "invalid source account"
}
Authorizations
Provide your API key in the 'apikey' header.
Headers
Body
application/json
Provide the required values for the request body.
Amount in Naira. Must be a positive value.
Example:
10
Source account number to be debited.
Example:
"0340899287"
Target account number to be credited.
Example:
"6009490194"
Optional narration/description for the fee charge.
Example:
"Fee Charge of N100"
Response
Created
The response is of type object.
⌘I