IntraBank Transfer

This API facilitates the transfer of funds from a source account to an account in the same financial institution.

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.
destinationAccountNUBAN	String	TRUE	NUBAN (bank account number) of the recipient's account.
amount	Decimal	TRUE	Amount to be transferred. Minimum 0.01.
narration	String	TRUE	Description or remark for the transaction.
transactionReference	String	FALSE	Your unique reference for this transfer, up to 100 characters, unique per source account. Send it to make retries safe and to look the transfer up later.

Response Body

The response contains the details of the transfer.

Field Name	Type	Description
transactionID	Integer	Unique identifier for the transaction. Omitted when the transfer is waiting for approval.
sourceAccountNUBAN	String	NUBAN (bank account number) of the sender's account.
destinationAccountNUBAN	String	NUBAN (bank account number) of the recipient's account.
amount	Decimal	Amount transferred.
narration	String	Description or remark for the transaction.
transactionReference	String	The reference sent in the request. Only returned when one was sent.

Retries and Transaction Reference

Send a unique transactionReference with every transfer. It is optional, but only transfers that carry one are protected against duplicates and can be looked up.

You send	Result
A new reference	The transfer is processed.
The same reference and the same details (source account, destination account, amount) after it completed	The original response is returned. Nothing is posted again.
The same reference and the same details while the first request is still processing	`409`. Nothing is posted again.
The same reference with different details	`403`. Nothing is posted.
No reference	The transfer is processed every time it is sent. It cannot be looked up.

After a timeout or a 5xx response, do not re-send straight away. The transfer may already have completed. Call GET /core/transfer/intra/query/{transactionReference}?sourceAccountNUBAN={sourceAccountNUBAN} first:

Status	What to do
`SUCCESSFUL`	The transfer is complete.
`IN_PROGRESS`	Query again shortly.
`FAILED`, or `404`	Safe to re-send with the same reference.
`PENDING_APPROVAL`	Waiting for approval. Do not re-send.
`CREDIT_FAILED`, `UNKNOWN`	Do not re-send. Contact support.

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",
  "destinationAccountNUBAN": "0000000031",
  "amount": 1,
  "narration": "intrabank Test Money",
  "transactionReference": "TRX-0001"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

{
  "sourceAccountNUBAN": "0000000017",
  "destinationAccountNUBAN": "0000000031",
  "amount": 1,
  "narration": "intrabank Test Money",
  "transactionID": 4,
  "transactionReference": "TRX-0001"
}

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🟠404| Source | Error | When |

🟠409| Source | Error | When |

🔴500| Source | Error | When |

Request Body#