Post Transactions

The "Post Transactions" endpoint allows users to initiate a new transaction within the system. This can be done by sending a POST request to the following endpoint: POST /api/postings/v1/posttransaction When using this endpoint, users need to include the necessary parameters to describe the transaction accurately. This includes details such as debitAccount, creditAccount, amount, and other relevant information. After a successful request, a new transaction will be initiated within the system.

Headers

NameValue

Content-Type*

application/json

Authorization*

Bearer <token>

Request-Reference

{unique-reference}

Body

NameData Type (length)RequiredDescription

debitAccount

string

The account to be debited on Udara360 This can either be a customer account or a general ledger account

creditAccount

string

The account to be credited This can either be a customer account or a general ledger account

amount

integer

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

feeCharge

integer

The fee charge is applied to the transaction The amount must be provided in the base currency, e.g. NGN 5000.50 should be provided as 500050 kobo

feeIncomeGL

string

The general ledger for fee income This is only required if FeeCharge is greater than 0

instrumentNumber

string

The instrument number associated with the transaction

narration

string

A description or narration of the transaction

unplaceLienAfterPosting

boolean

Whether to remove the lien after posting If the originator account has a lien, that should not be considered and removed after a successful transaction

lienReferenceNumber

string

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

merchant

string

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

postingsTransactionType

string

The type of transaction for postings is based on the originator and beneficiary accounts. This allows the system to set the right sort code for easy transaction grouping The enumerations are: 1 = GLCustomer

2 = GLGL

3 = CustomerCustomer

additionalMetadata

object

Additional metadata related to the transaction

additionalMetadata.orig_AcctNo

string

The originator's account number

additionalMetadata.orig_Name

string

The originator's account holder's name

additionalMetadata.orig_BVN

string

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

additionalMetadata.orig_BankCode

string

The originator's bank's code

additionalMetadata.orig_BankName

string

The originator's bank's name

additionalMetadata.benf_AcctNo

string

The beneficiary account number

additionalMetadata.benf_Name

string

The beneficiary's name

additionalMetadata.benf_BVN

string

The beneficiary's Bank Verification Number (BVN)

additionalMetadata.benf_BankCode

string

The beneficiary bank's code

additionalMetadata.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/posttransaction' \
--header 'Authorization: bearer {token}' \
--header 'request-reference: {unique_reference}' \
--header 'Content-Type: application/json' \
--data '{
  "debitAccount": "string",
  "creditAccount": "string",
  "amount": 0,
  "feeCharge": 0,
  "feeIncomeGL": "string",
  "instrumentNumber": "stringstri",
  "narration": "string",
  "unplaceLienAfterPosting": true,
  "lienReferenceNumber": "string",
  "merchant": "string",
  "postingsTransactionType": "string",
  "additionalMetadata": {
    "orig_AcctNo": "string",
    "orig_Name": "string",
    "orig_BVN": "string",
    "orig_BankCode": "string",
    "orig_BankName": "string",
    "benf_AcctNo": "string",
    "benf_Name": "string",
    "benf_BVN": "string",
    "benf_BankCode": "string",
    "benf_BankName": "string"
  }'
Respose: 200
{
  "status": true,
  "message": "string",
  "data": {
    "statusCode": "string",
    "referenceNumber": "string",
    "instrumentNumber": "string"
  }
}

Visit the response code page for a list of all posting status code and their descriptions.

Last updated