Skip to main content

Inter-Bank Transaction

POST /api/v{version}/Transactions/inter-bank

Description​

This endpoint is used to initiate an inter-bank transaction. It allows transferring funds from one bank account to another across different banks.

Parameters​

  • version (string, path, required): The version of the API.
  • Accept-Language (string, header, optional): Change the default response message language from English (en). Available languages are fr and en.

Request Body​

  • Media Type: application/json

Example Value​

{
  "amount": 0,
  "bankCode": "string",
  "bankName": "string",
  "senderAccountNumber": "string",
  "recipientAccountNumber": "string",
  "recipientAccountName": "string",
  "description": "string",
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Responses​

200 Success Media type: Controls Accept header.

Example Value:​

{
  "succeeded": true,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": "string"
}

400 Bad Request​

  • Media type: application/json

Example Value​

{
  "succeeded": false,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": "string"
}

404 Not Found​

  • Media type: application/json

Example Value​

{
  "succeeded": false,
  "message": "string",
  "errors": [
    "string"
  ],
  "data": "string"
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /api/v{version}/Transactions/inter-bank \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!