Debit Account

This API debits an virtual account. For this operation to be successful, a classificationCode must be entered. A classification code allows the accounting system understand which accouting ledger and payment type should be used for the transaction.

Request Body

Field Name	Type	Required	Description
accountID	string	TRUE	Unique identifier for the account to be debited.
classificationCode	string	TRUE	Code that classifies the type of debit operation.
amount	decimal	TRUE	The amount to be debited from the account.
narration	string	TRUE	A brief description or note regarding the transaction.
transactionReference	string	FALSE	A unique reference assigned to the transaction.

Response Body

Field Name	Type	Description
accountID	string	Unique identifier for the account that was debited.
classificationCode	string	Code that classifies the type of debit operation.
amount	decimal	The amount that was debited from the account.
narration	string	A brief description or note regarding the transaction.
transactionReference	string	The unique reference assigned to the transaction.
transactionType	string	The type of transaction; for this operation, it will be 'DEBIT'.
success	boolean	Indicates whether the debit operation was successful.
traceID	string	A system-generated trace ID used for tracking the transaction.
transactionTime	string	The timestamp when the transaction was processed.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Debit Account

application/json

Body

Example

{
    "transactionType": "DEBIT",
    "amount": 7,
    "narration": "Transactional Test",
    "classificationCode": "SUBLEDGER001_CREDIT",
    "success": true,
    "traceID": "04c46c69-1e56-4a4e-8158-bc908ccbab2d",
    "transactionReference": "NG-0004",
    "accountID": "0000000238",
    "transactionTime": "2023-03-22T12:28:40.034+00:00"
}

Request Body#

Response Body#

Request

Request samples

Responses

Request Body

Response Body