InterBank Transfer Query

This API retrieves details of a previously initiated interbank transfer using a unique transaction reference to find the transaction status and details. Find description of the different transaction status below:

Transaction Status

SUBMITTED - Transaction Submitted but not approved

AUTHORIZED - Transaction Authorized and transfer initiated

SENT_TO_GATEWAY_SUCCESS - Transfer Sent Successfully But Not Confirmed By NIBSS and Receiving Institution yet

SENT_TO_GATEWAY_ERROR - Error Sending Transfer through NIBSS to Receiving Institution

UNRESOLVED - Failed In Sending Transfer, Needs Resolution

REJECTED - Transfer Rejected By Admin

CONFIRMED - Transaction confirmed by NIBSS And Receiving Institution

Request Parameters

Field Name	Type	Mandatory	Description
transactionReference	String	TRUE	Unique reference identifier for the transaction.

Response Body

Field Name	Description
id	Unique identifier for the transaction.
type	Transaction type (`INTERBANK_TRANSFER`).
destinationInstitutionCode	Institution code of the recipient’s bank.
destinationBankName	Name of the recipient’s bank.
destinationAccountName	Full name of the recipient’s account holder.
destinationAccountNUBAN	NUBAN (bank account number) of the recipient.
amount	Amount transferred.
currency	Currency of the transaction (e.g., `NGN`).
narration	Description or remark associated with the transaction.
transactionDate	Date and time the transaction was initiated.
transactionReference	Unique reference identifier for tracking the transaction.
sessionID	Unique session identifier for tracking the transaction.
transactionStatus	Current status of the transaction (e.g., `CONFIRMED`).
createdDate	Timestamp when the transaction record was created.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "id": 15795,
  "type": "INTERBANK_TRANSFER",
  "destinationInstitutionCode": "100004",
  "destinationBankName": "OPAY",
  "destinationAccountName": "Sample Customer 7",
  "destinationAccountNUBAN": "0000000999",
  "amount": 50,
  "currency": "NGN",
  "narration": "999999240521120152468638965354",
  "transactionDate": "2024-05-21T00:00:00.000+00:00",
  "transactionReference": "7cbebb8e-4164-4542-a300-5550c035a514",
  "sessionID": "999999240521120239290445362008",
  "transactionStatus": "CONFIRMED",
  "createdDate": "2024-05-21T11:02:30.000+00:00"
}

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Transaction Status#

Request Parameters#

Response Body#

Request

Request Code Samples

Responses

Transaction Status

Request Parameters

Response Body