Skip to main content
POST
Merchant Fee Charge

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

Request Body

Response

Status Code: 201 Created Content-Type: application/json

Example Response

Response Fields

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.

Authorizations

apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

x-carbon-key
string
required

Body

application/json

Provide the required values for the request body.

amount
number
required

Amount in Naira. Must be a positive value.

Example:

10

sourceAccountId
string
required

Source account number to be debited.

Example:

"0340899287"

targetAccountId
string
required

Target account number to be credited.

Example:

"6009490194"

description
string

Optional narration/description for the fee charge.

Example:

"Fee Charge of N100"

Response

Created

The response is of type object.