Interbank Transfer

This API facilitates fund transfers from a source account to a recipient account in another financial institution, ensuring secure and efficient transactions.

Request Body

The request should be a JSON object containing the following fields:

Field Name	Type	Required	Description
sourceAccountNUBAN	string	TRUE	NUBAN (bank account number) of the sender’s account.
destinationInstitutionCode	string	TRUE	Institution code of the recipient’s bank.
destinationAccountNUBAN	string	TRUE	NUBAN (bank account number) of the recipient.
destinationBankName	string	TRUE	Official name of the recipient’s bank.
destinationAccountName	string	TRUE	Full name of the recipient’s account holder.
nameInquiryReference	string	TRUE	Reference from name inquiry request.
destinationAccountBVN	string	FALSE	Bank Verification Number (BVN) of the recipient (if available).
amount	number	TRUE	Amount to be transferred.
narration	string	TRUE	Description or remark for the transaction.
transactionReference	string	TRUE	Unique reference identifier for tracking the transaction.
callback	string	FALSE	URL to receive transaction status updates.

Response Body

The response contains details of the initiated transfer.

Field Name	Type	Description
id	number	Unique identifier for the transaction.
type	string	Transaction type (`INTERBANK_TRANSFER`).
destinationInstitutionCode	string	Institution code of the recipient’s bank.
destinationBankName	string	Name of the recipient’s bank.
destinationAccountName	string	Name of the recipient’s account holder.
destinationAccountNUBAN	string	NUBAN (bank account number) of the recipient.
amount	number	Amount transferred.
narration	string	Description or remark for the transaction.
transactionDate	string	Date and time the transaction was initiated (ISO 8601 format).
transactionReference	string	Unique reference identifier for the transaction.
transactionStatus	string	Status of the transaction (e.g., `AUTHORIZED`).
createdDate	string	Timestamp when the transaction record was created (ISO 8601 format).

Request

Authorization

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

Body Params application/json

Example

{
  "sourceAccountNUBAN": "0000000017",
  "destinationInstitutionCode": "000001",
  "destinationAccountNUBAN": "0000000771",
  "destinationBankName": "STERLING BANK PLC",
  "destinationAccountName": "Sample Customer",
  "nameInquiryReference": "75666576757",
  "destinationAccountBVN": "00000000000",
  "amount": 1,
  "narration": "Test Transfer",
  "transactionReference": "NG-3434343t489211",
  "callback": "https://www.google.com"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "id": 9,
  "type": "INTERBANK_TRANSFER",
  "destinationInstitutionCode": "000001",
  "destinationBankName": "STERLING BANK PLC",
  "destinationAccountName": "Sample Customer",
  "destinationAccountNUBAN": "0000000771",
  "amount": 1,
  "narration": "Test Transfer",
  "transactionDate": "2023-11-05T08:54:30.749+00:00",
  "transactionReference": "NG-3434343t489211",
  "transactionStatus": "AUTHORIZED",
  "createdDate": "2023-11-05T08:54:30.942+00:00"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🔴500| Source | Error | When |

Request Body#

Response Body#

Request

Request Code Samples

Responses

Request Body

Response Body