Get Subledger transfers

This API retrieves the subledger transfers for a merchant based on the provided client ID and nuban. It returns an array of transfer objects that include detailed information about each transaction.

Path Parameters

Field Name	Type	Required	Description
clientId	string	TRUE	The unique identifier of the client/merchant.
nuban	string	TRUE	The bank account number of the client/merchant.

Response Body

Each transfer object in the returned array includes the following fields:

Field Name	Type	Description
inward	Boolean	Indicates whether the transaction is incoming (`true`) or outgoing (`false`).
totalCharge	Integer	The total fee charged for processing the transaction.
availableAmount	Integer	The remaining balance in the source account after the transaction.
sourceInstitutionCode	String	The unique code identifying the financial institution of the sender.
destinationInstitutionCode	String	The unique code identifying the financial institution of the recipient.
sourceBankName	String	The name of the bank initiating the transaction.
sourceAccountName	String	The name associated with the sender's bank account.
sourceAccountNUBAN	String	The NUBAN (Bank Account Number) of the sender's account.
destinationBankName	String	The name of the recipient's bank.
destinationAccountName	String	The name associated with the recipient's bank account.
destinationAccountNUBAN	String	The NUBAN of the recipient's account.
amount	Integer	The amount of money transferred in the transaction.
narration	String	A short description or reference provided for the transaction.
classificationCode	String	A classification identifier for categorizing the transaction type.
transactionStatus	String	The current status of the transaction (e.g., `UNRESOLVED`).
traceID	String	A unique identifier used for tracking the transaction (may be `null` if not available).
transactionReference	String	A unique reference number assigned to the transaction for tracking purposes.

Responses

🟢200Set SubLedger Callback Urls

application/json

Body

Example

[
    {
        "inward": true,
        "totalCharge": 2000,
        "availableAmount": 50000,
        "sourceInstitutionCode": "090605",
        "destinationInstitutionCode": "000013",
        "sourceBankName": "Madobi Microfinance Bank",
        "sourceAccountName": "iRecharge",
        "sourceAccountNUBAN": "9900000839",
        "destinationBankName": "GUARANTY TRUST BANK PLC",
        "destinationAccountName": "JOSEPH SAMUEL OLUWASEUN",
        "destinationAccountNUBAN": "0021459404",
        "amount": 1000,
        "narration": "iRecharge",
        "classificationCode": "NIP0001_DEBIT",
        "transactionStatus": "UNRESOLVED",
        "traceID": null,
        "transactionReference": "090605240123164925947709536560"
    },
    {
        "inward": true,
        "totalCharge": 2000,
        "availableAmount": 50000,
        "sourceInstitutionCode": "090605",
        "destinationInstitutionCode": "000013",
        "sourceBankName": "Madobi Microfinance Bank",
        "sourceAccountName": "iRecharge",
        "sourceAccountNUBAN": "9900000839",
        "destinationBankName": "GUARANTY TRUST BANK PLC",
        "destinationAccountName": "JOSEPH SAMUEL OLUWASEUN",
        "destinationAccountNUBAN": "0021459404",
        "amount": 1000,
        "narration": "iRecharge",
        "classificationCode": "NIP0001_DEBIT",
        "transactionStatus": "UNRESOLVED",
        "traceID": null,
        "transactionReference": "090605240123164925947709536560"
    }
]

Path Parameters

Response Body

Request

Request samples

Responses

Get Subledger transfers

Path Parameters#

Response Body#

Request

Request samples

Responses

Path Parameters

Response Body