Get Transfer History

This API retrieves the transfer history for a merchant based on the provided client ID. 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.

Response Body

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

Field Name	Type	Description
id	integer	Unique identifier for the transfer transaction.
resourceId	string	Optional resource identifier associated with the transfer.
sourceInstitutionCode	string	Code representing the source institution (if available).
destinationInstitutionCode	string	Code representing the destination institution (if available).
sourceAccountNUBAN	string	The NUBAN of the source account.
sourceBankName	string	The name of the source bank (if available).
destinationBankName	string	The name of the destination bank.
institutionCode	string	Institution code involved in the transfer.
destinationAccountNumber	string	The destination account number.
destinationAccountName	string	The name associated with the destination account.
destinationBankVerificationNumber	string	Bank verification number for the destination (if available).
destinationKYCLevel	string	KYC level of the destination account.
transactionLocation	string	Geographic coordinates related to the transaction.
amount	integer	The amount transferred.
transferType	string	The type of transfer (e.g., NIBSS).
narration	string	A note or description associated with the transfer.
transactionDate	string	Transaction date and time in ISO format.
transactionDateString	string	Transaction date as a formatted string.
authorizedBy	integer	Identifier of the user who authorized the transaction.
initiatedBy	integer	Identifier of the user who initiated the transaction.
authorizedStatus	boolean	Indicates whether the transfer was authorized.
transactionStatus	string	Current status of the transaction (e.g., CONFIRMED).
responseCode	string	Response code indicating the transaction outcome.
rejectionReason	string	Reason for rejection if the transaction was not approved.
nameInquiryReference	string	Reference for the name inquiry associated with the transaction.
transactionReference	string	Unique reference for the transaction.
tpGatewayTransactionReference	string	Third-party gateway transaction reference (if available).
paymentReference	string	Payment reference for the transaction.
sessionID	string	Identifier for the transaction session.
errorMessage	string	Error message if an error occurred during the transaction.
gatewayProcessTime	string	Timestamp when the gateway processed the transaction.
gatewayProcessTimeString	string	Formatted gateway process time.
savingsAccountNoID	integer	Identifier for the associated savings account.
createdDate	string	Timestamp when the transfer record was created.
createdDateString	string	Formatted creation date.
initiatedUserName	string	Name of the user who initiated the transaction (if available).
sourceAccountName	string	Name associated with the source account (if available).
currency	string	Currency used in the transaction (if available).
classificationCode	string	Code classifying the transaction (if available).
isSubLedger	boolean	Indicates if the transfer is related to a subledger.
transferDetails	object	Additional details for the transfer (if available).
inward	boolean	Indicates if the transfer is an inward transfer.
totalCharges	integer	Total charges applied to the transaction.
availableAmount	number	The available amount after the transfer (if applicable).
splitPayments	array	Details of any split payments, if applicable.
merchantSplitPayments	array	Details of any merchant split payments, if applicable.
splitCharges	array	Details of any split charges, if applicable.

Responses

🟢200Get Transfer History

application/json

Body

Example

[
    {
        "id": 35802,
        "resourceId": null,
        "sourceInstitutionCode": null,
        "destinationInstitutionCode": null,
        "sourceAccountNUBAN": "9900000839",
        "sourceBankName": null,
        "destinationBankName": "OPAY",
        "institutionCode": "100004",
        "destinationAccountNumber": "7032309584",
        "destinationAccountName": "OLUWASEUN SAMUEL JOSEPH",
        "destinationBankVerificationNumber": null,
        "destinationKYCLevel": "1",
        "transactionLocation": "0.2009,0.1001",
        "amount": 3000,
        "transferType": "NIBSS",
        "narration": "iRecharge",
        "transactionDate": "2024-12-07T00:00:00.000+00:00",
        "transactionDateString": "07-12-2024",
        "authorizedBy": 250,
        "initiatedBy": 250,
        "authorizedStatus": true,
        "transactionStatus": "CONFIRMED",
        "responseCode": "00",
        "rejectionReason": null,
        "nameInquiryReference": "090605241207090136012591934683",
        "transactionReference": "090605241207090138223197765685",
        "tpGatewayTransactionReference": null,
        "paymentReference": "ef17998135394a558b9444f7e5a13b23",
        "sessionID": "999999241207090138368957834490",
        "errorMessage": null,
        "gatewayProcessTime": "2024-12-07T09:01:40.000+00:00",
        "gatewayProcessTimeString": "07-12-2024 08:01:40",
        "savingsAccountNoID": 17,
        "createdDate": "2024-12-07T09:01:37.000+00:00",
        "createdDateString": "07-12-2024 08:01:37",
        "initiatedUserName": null,
        "sourceAccountName": null,
        "currency": null,
        "classificationCode": null,
        "isSubLedger": true,
        "transferDetails": null,
        "inward": false,
        "totalCharges": 0,
        "availableAmount": null,
        "splitPayments": [],
        "merchantSplitPayments": [],
        "splitCharges": []
    },
    {
        "id": 35801,
        "resourceId": null,
        "sourceInstitutionCode": null,
        "destinationInstitutionCode": null,
        "sourceAccountNUBAN": "9900000839",
        "sourceBankName": null,
        "destinationBankName": "MONIEPOINT MICROFINANCE BANK",
        "institutionCode": "090405",
        "destinationAccountNumber": "8190578209",
        "destinationAccountName": "POS Transfer - AHMED UMAR",
        "destinationBankVerificationNumber": null,
        "destinationKYCLevel": "1",
        "transactionLocation": "0.2009,0.1001",
        "amount": 2200,
        "transferType": "NIBSS",
        "narration": "iRecharge",
        "transactionDate": "2024-12-07T00:00:00.000+00:00",
        "transactionDateString": "07-12-2024",
        "authorizedBy": 250,
        "initiatedBy": 250,
        "authorizedStatus": true,
        "transactionStatus": "CONFIRMED",
        "responseCode": "00",
        "rejectionReason": null,
        "nameInquiryReference": "090605241207083942101768287131",
        "transactionReference": "090605241207083943649901462368",
        "tpGatewayTransactionReference": null,
        "paymentReference": "2629aad313c646f49bba051fd5c42cb4",
        "sessionID": "999999241207083944539370695415",
        "errorMessage": null,
        "gatewayProcessTime": "2024-12-07T08:39:46.000+00:00",
        "gatewayProcessTimeString": "07-12-2024 07:39:46",
        "savingsAccountNoID": 17,
        "createdDate": "2024-12-07T08:39:43.000+00:00",
        "createdDateString": "07-12-2024 07:39:43",
        "initiatedUserName": null,
        "sourceAccountName": null,
        "currency": null,
        "classificationCode": null,
        "isSubLedger": true,
        "transferDetails": null,
        "inward": false,
        "totalCharges": 0,
        "availableAmount": null,
        "splitPayments": [],
        "merchantSplitPayments": [],
        "splitCharges": []
    },
    {
        "id": 35800,
        "resourceId": null,
        "sourceInstitutionCode": null,
        "destinationInstitutionCode": null,
        "sourceAccountNUBAN": "9900000839",
        "sourceBankName": null,
        "destinationBankName": "UNITED BANK FOR AFRICA",
        "institutionCode": "000004",
        "destinationAccountNumber": "2063407091",
        "destinationAccountName": "UMAR AHMED JAFAR",
        "destinationBankVerificationNumber": null,
        "destinationKYCLevel": "1",
        "transactionLocation": "0.2009,0.1001",
        "amount": 2200,
        "transferType": "NIBSS",
        "narration": "iRecharge",
        "transactionDate": "2024-12-07T00:00:00.000+00:00",
        "transactionDateString": "07-12-2024",
        "authorizedBy": 250,
        "initiatedBy": 250,
        "authorizedStatus": true,
        "transactionStatus": "SENT_TO_GATEWAY_ERROR",
        "responseCode": null,
        "rejectionReason": null,
        "nameInquiryReference": "090605241207083705347605889293",
        "transactionReference": "241207493272",
        "tpGatewayTransactionReference": null,
        "paymentReference": "c53f8c819c9b40ee898cb19db84

🟢200Get Transfer History [By SESSION ID]

🟢200Get Transfer History [By NUBAN]

Path Parameters

Response Body

Request

Request samples

Responses

Get Transfer History

Path Parameters#

Response Body#

Request

Request samples

Responses

Path Parameters

Response Body