logoOPEN BANKING DOCS

Process transfer

Process a single transfer between accounts.

What this endpoint does

Use this endpoint to move funds from one account to another. It is suitable for one‑off transfers where you control both the source and destination details.

POST
/transactions/transfer
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}$
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" \  -H "X-API-Key: string" \  -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "fromAccountNumber": "string",    "toAccountNumber": "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"
}