Interbank Transfer [Sync]

The API processes the interbank transfers in real-time. This endpoint is highly discouraged as it negatively impacts the interbank transfer workflow

Request Body

Field Name	Type	Required	Description
sourceAccountNUBAN	String	Yes	The NUBAN (Bank Account Number) of the account initiating the transfer.
destinationInstitutionCode	String	Yes	The code representing the financial institution receiving the transfer.
destinationAccountNUBAN	String	Yes	The NUBAN of the beneficiary account.
amount	Integer	Yes	The amount to be transferred.
narration	String	No	A brief description or reference for the transaction.
transactionReference	String	Yes	A unique identifier for tracking the transaction.
callback	String	No	The URL to which a callback notification will be sent upon transaction completion.

Response Body

Field Name	Type	Description
id	Integer	Unique identifier for the transaction record.
destinationInstitutionCode	String	The code of the financial institution where the funds were sent.
destinationAccountNUBAN	String	The NUBAN of the beneficiary account.
amount	Integer	The amount transferred.
currency	String	The currency in which the transaction was made (e.g., NGN for Nigerian Naira).
narration	String	The description or reference provided for the transaction.
transactionDate	String	The date and time the transaction was initiated.
transactionReference	String	A unique identifier assigned to the transaction for tracking.
transactionStatus	String	The current status of the transaction (e.g., `SENT_TO_GATEWAY_SUCCESS`).
transactionID	String	A unique transaction identifier assigned by the payment gateway.
sessionID	String	A unique session identifier for tracking the transaction lifecycle.
clientID	Integer	The identifier for the client initiating the transaction.
createdDate	String	The timestamp indicating when the transaction was recorded in the system.

Request

Body Params application/json

Example

{
    "sourceAccountNUBAN":"9900000774",
    "destinationInstitutionCode": "000012",
    "destinationAccountNUBAN":"0040088210",
    "bvn":"1232193232",
    "classificationCode": "NIP0001_DEBIT",
    "amount":10,
    "narration":"Test Transfer",
    "transactionReference":"NG-101010105"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "id": 294,
    "destinationInstitutionCode": "000012",
    "destinationAccountNUBAN": "0040088210",
    "amount": 10,
    "currency": "NGN",
    "narration": "Test Transfer",
    "transactionDate": "2023-10-27T05:36:24.856+00:00",
    "transactionReference": "NG-101010104",
    "transactionStatus": "SENT_TO_GATEWAY_SUCCESS",
    "transactionID": "090605231027023704666609145034",
    "sessionID": "999999231027023704131530310768",
    "clientID": 30,
    "createdDate": "2023-10-27T05:36:24.856+00:00"
}

🟢200Error

Request Body#

Response Body#

Request

Request samples

Responses

Request Body

Response Body