Create Transfer

POST /openbanking/transfer/{bankCode}

Description

Creates a transfer to a specified bank using the provided details. This endpoint allows for batch transactions within the open banking system.

URL Parameters:

Name	Type	Description
bankCode	string	(Required) The bank code of the receiving bank.

Headers:

Name	Type	Description
tenantId	string	(Required) The tenant ID of the user initiating the transfer.
countryCode	string	(Required) The country code of the transaction.
userId	string	(Required) The user ID of the account holder.

Request Body:

Name	Type	Description
corporateAccount	string	The corporate account number for the transaction.
transactionBatch	array	A list of transactions to be executed.

Each item in the transactionBatch array should include:

Name	Type	Description
amount	number	The amount to be transferred.
narration	string	A description or narration for the transaction.
bankCode	string	The code of the bank receiving the transaction.
currency	string	The currency of the transaction. Example: USD.
beneficiaryAccount	string	The account number of the beneficiary.

Sample Request Body:

{
         "corporateAccount": "string",
         "transactionBatch": [
           {
             "amount": 50,
             "narration": "string",
             "bankCode": "string",
             "currency": "string",
             "beneficiaryAccount": "string"
           }
         ]
       }'

Sample Response:

200: The transfer was processed successfully.

{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "data": {},
      "descriptiveMessage": "string"
    }
  ]
}