Post Transactions For Multiple Debits and Credits

This endpoint enables users to process multiple debits and credits efficiently. When making a request to this endpoint, you will need to provide the required body parameters, including accountNumber, amount, recordType, narration.and any other relevant details.

POST /api/postings/v1/post

Headers

NameValue

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body

NameData Type (length)RequiredDescription

postingEntryRequest

array

An array of objects detailing the accounts involved in the posting

postingEntryRequest.accountNumber

string

The account number for the transaction This can either be a customer account or a general ledger account

postingEntryRequest.amount

integer

The amount involved in the transaction The amount must be provided in the base currency, e.g. NGN 5000.50 should be provided as 500050 kobo

postingEntryRequest.recordType

integer

The type of record (e.g., debit or credit) The enumerations are: 1 = Debit 2 = Credit The sum of Total Debits (Amount) must equal the Sum of Total Credits (Amount); the number of Debit entries can differ.

postingEntryRequest.narration

string

A description or narration of the transaction

postingEntryRequest.instrumentNumber

string

This is the instrument number associated with the transaction. The system generates a UUID if empty. We recommend you pass a value if you perform a transaction retrial.

postingDataRequest

object

The object containing additional data for the posting

postingDataRequest.unplaceLienAfterPosting

boolean

Whether to remove the lien after posting, set true for yes and false for no

postingDataRequest.lienReferenceNumber

string

The reference number for the lien This is only required if UnplaceLienAfterPosting is true

postingDataRequest.merchant

string

The merchant involved in the transaction can be any for bill payment (E.g., DSTV, MTN, or Bet9ja)

postingDataRequest.additionalMetadata

object

Additional metadata related to the transaction

postingDataRequest.orig_AcctNo

string

The originator's account number

postingDataRequest.orig_Name

string

The originator's account holder's name

postingDataRequest.orig_BVN

string

The originator's account holder's Bank Verification Number (BVN)

postingDataRequest.orig_BankCode

string

The originator's bank's code

postingDataRequest.orig_BankName

string

The originator's bank's name

postingDataRequest.benf_AcctNo

string

The beneficiary account number

postingDataRequest.benf_Name

string

The beneficiary's name

postingDataRequest.benf_BVN

string

The beneficiary's Bank Verification Number (BVN)

postingDataRequest.benf_BankCode

string

The beneficiary bank's code

postingDataRequest.benf_BankName

string

The beneficiary bank's name

Here is an example request and response with a sample payload sent to the endpoint in Curl format.

Sample Request
curl --location -g '{{baseurl}}/api/postings/v1/post' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "postingEntryRequest": [
    {
      "accountNumber": "1000000699",
      "amount": 10000,
      "recordType": 1,
      "narration": "test",
      "instrumentNumber": "7564238"
    },
{
      "accountNumber": "1000000675",
      "amount": 10000,
      "recordType": 2,
      "narration": "test",
      "instrumentNumber": "7564238"
    }
  ],
  "postingDataRequest": {
    "unplaceLienAfterPosting": false,
    "lienReferenceNumber": "",
    "merchant": "",
    "additionalMetadata": {
    "orig_AcctNo": "1000000699",
    "orig_Name": "Test User",
    "orig_BVN": "11111111111",
    "orig_BankCode": "999998",
    "orig_BankName": "GTB",
    "benf_AcctNo": "1000000675",
    "benf_Name": "Test User 2",
    "benf_BVN": "10000000000",
    "benf_BankCode": "999923",
    "benf_BankName": "XYZ MFB"
  }
  }
}'
Respose: 200
{
  "status": true,
  "message": "string",
  "data": {
    "statusCode": "string",
    "referenceNumber": "string",
    "instrumentNumber": "string"
  }
}

Last updated