OPEN BANKING DOCSGet account statement
Retrieve account statement with optional filtering
X-API-Key<token>
In: header
Query Parameters
accountNumberstring
10-digit account number
Match
^[0-9]{10}$startDate?string
Start date for statement period
Format
dateendDate?string
End date for statement period
Format
datepage?integer
Page number
Default
1Range
1 <= valuepageSize?integer
Number of items per page
Default
20Range
1 <= value <= 100Header Parameters
X-API-Keystring
API key for the application
X-App-Idstring
UUID of the application
Format
uuidResponse Body
curl -X GET "https://virtual-accounts-api.vantacrest.com/company/v1/accounts/statement?accountNumber=string&startDate=2019-08-24&endDate=2019-08-24&page=1&pageSize=20" \ -H "X-API-Key: string" \ -H "X-App-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": {
"accountNumber": "string",
"accountName": "string",
"period": {
"startDate": "2019-08-24",
"endDate": "2019-08-24"
},
"transactions": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"amount": 0,
"currency": "string",
"flow": "INFLOW",
"narration": "string",
"reference": "string",
"status": "PENDING",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"currentPage": 0,
"totalPages": 0,
"totalItems": 0,
"pageSize": 0
}
}
}{
"success": true,
"message": "string",
"data": {},
"timestamp": "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"
}