Credit Account [Agency Banking]

POST

/credit

This operation credits a virtual account balance but it requires a corresponding debit from a main virtual account. This endpoint is only to be used for agency banking and not typical virtual accouting services.

Request Body

Name	Type	Constraint
accountID	string	required
classificationCode	string	required
amount	decimal	required
narration	string	required
transactionReference	string	required

Response Body

Name	Type
accountID	string
classificationCode	string
amount	decimal
narration	string
transactionReference	string
transactionType	string
success	boolean
traceID	string
transactionTime	string

Request

Body Params application/json

Example

{
    "accountID":"0000000238",
    "classificationCode":"SUBLEDGER001_CREDIT",
    "amount":7,
    "narration":"Transactional Test",
    "transactionReference":"NG-0004"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/credit' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountID":"0000000238",
    "classificationCode":"SUBLEDGER001_CREDIT",
    "amount":7,
    "narration":"Transactional Test",
    "transactionReference":"NG-0004"
}'

Responses

🟢200Credit Account

application/json

Body

Example

{
    "transactionType": "CREDIT",
    "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"
}

Modified at 2025-03-15 06:08:42

Debit Account

Debit Account [Agency Banking]