logoOPEN BANKING DOCS

Process interbank transfer

Process a transfer to an external bank account

POST
/transactions/transfer/interbank
X-API-Key<token>

In: header

Header Parameters

X-API-Keystring

API key for the application

X-App-Idstring

UUID of the application

Formatuuid
fromAccountNumberstring

Source account number

Match^[0-9]{10}$
toAccountNumberstring

Destination account number

Match^[0-9]{10}$
bankCodestring

Destination bank code

amountnumber

Transfer amount

Formatdecimal
Range0.01 <= value
narrationstring

Transfer description

reference?string | null

Optional reference number

Response Body

curl -X POST "https://virtual-accounts-api.vantacrest.com/company/v1/transactions/transfer/interbank" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "fromAccountNumber": "string",    "toAccountNumber": "string",    "bankCode": "string",    "amount": 0.01,    "narration": "string"  }'
{
  "data": {
    "transactionId": "string",
    "reference": "string",
    "status": "PENDING",
    "amount": 0,
    "fee": 0,
    "fromAccount": "string",
    "toAccount": "string",
    "narration": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}
{
  "success": true,
  "message": "string",
  "data": {},
  "timestamp": "2019-08-24T14:15:22Z"
}