Transfer Query

This API endpoint retrieves the current status of an interbank transfer associated with the provided transaction reference. The transaction reference is supplied as a path variable in the URL. The response returns detailed metadata about the transfer, including its status.

Path Variable

Field Name	Type	Required	Description
transactionReference	string	TRUE	The unique reference identifier used when the transaction was initiated.

Response Body

Field Name	Type	Description
id	integer	Unique identifier for the transfer transaction.
destinationInstitutionCode	string	Code identifying the destination institution.
destinationBankName	string	Name of the destination bank.
destinationAccountName	string	Name associated with the destination account.
destinationAccountNUBAN	string	The NUBAN (account number) of the destination account.
amount	integer	The amount transferred.
currency	string	The currency in which the transfer was executed (e.g., NGN).
narration	string	A note or description regarding the transfer.
transactionDate	string	Timestamp indicating when the transfer was processed.
transactionReference	string	The same unique reference identifier that was used when initiating the transfer.
tpTransactionID	string	The third-party transaction identifier, if applicable.
sessionID	string	An identifier for tracking the transfer session.
transactionStatus	string	The current status of the transfer (e.g., CONFIRMED, PENDING, FAILED).
clientID	integer	Identifier of the client who initiated the transfer.
createdDate	string	Timestamp when the transfer record was created.

Transaction Statuses

Status	Description
SUBMITTED	Transaction submitted but not yet approved.
AUTHORIZED	Transaction authorized, and transfer initiated.
SENT_TO_GATEWAY_SUCCESS	Transfer sent successfully but not yet confirmed by NIBSS and the receiving institution.
SENT_TO_GATEWAY_ERROR	Error occurred while sending the transfer through NIBSS to the receiving institution.
PENDING	Transaction is still processing.
UNRESOLVED	Transfer failed to send and requires resolution.
REJECTED	Transfer was rejected by an admin.
CONFIRMED	Transaction confirmed by NIBSS and the receiving institution.

Responses

🟢200Transfer Query

application/json

Body

Example

{
    "id": 283,
    "destinationInstitutionCode": "000014",
    "destinationBankName": "ACCESS BANK PLC",
    "destinationAccountName": "MOHAMMED WAZIRI IDRISA",
    "destinationAccountNUBAN": "0075047718",
    "amount": 1000,
    "currency": "NGN",
    "narration": "iRecharge",
    "transactionDate": "2023-10-27T00:00:00.000+00:00",
    "transactionReference": "231027450809",
    "transactionID": "090605231027023704666609145034",
    "sessionID": "999999231027023704131530310768",
    "transactionStatus": "CONFIRMED",
    "clientID": 35,
    "createdDate": "2023-10-27T01:37:02.000+00:00"
}

Path Variable

Response Body

Transaction Statuses

Request

Request Code Samples

Responses

Transfer Query

Path Variable#

Response Body#

Transaction Statuses#

Request

Request Code Samples

Responses

Path Variable

Response Body

Transaction Statuses