Create Connect report
This endpoint allows you to request a Connect report for a selected bankAccountId and specific period. Once requested, your report will be generated asynchronously and available at the /reports/id/download endpoint as a CSV file once it's been generated. Check on the availability status of your report using the /reports/{id} endpoint.
The startDate and endDate may be a maximum of 92 days apart, allowing you to generate reports covering up to 3 months of data.
If allowEmpty is not provided or is set to false, the report is not generated when there are no available entries, and an error is returned.
The optional dateFilterType parameter allows you to specify whether the report should filter by createdAt (default) or updatedAt. When not provided, dateFilterType defaults to createdAt.
Authorization
oauth OAuth2 password grant - see the documentation in the oAuth2 Authentication section
In: header
Path Parameters
Connect bank account ID that you're requesting report for
Request Body
application/json
The start date from which account operations data should be gathered, based on the field specified by dateFilterType. Appears in error responses as filters.createdAt.lte or filters.updatedAt.lte depending on dateFilterType.
date-timeThe end date up to which account operations data should be gathered, based on the field specified by dateFilterType. Appears in error responses as filters.createdAt.lte or filters.updatedAt.lte depending on dateFilterType.
date-timeSpecifies which date field to use for filtering. Accepts either createdAt or updatedAt. Defaults to createdAt if not provided.
"createdAt" | "updatedAt"Types of transactions to include in the Connect report. If not provided, all transaction types are included.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.sandbox.volt.io/reports/connect/string" \ -H "Content-Type: application/json" \ -d '{ "startDate": "2023-08-21T18:32:00+00:00", "endDate": "2023-08-28T18:32:00+00:00", "transactionTypes": [ "PAYMENT", "REFUND" ] }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "REPORT_REQUESTED",
"createdAt": "2019-08-24T14:15:22Z"
}{
"exception": {
"code": 400,
"message": "Bad Request"
}
}{
"exception": {
"code": 400,
"message": "Validation exception",
"errorList": [
{
"property": "propertyName",
"message": "Error message"
}
]
}
}{
"exception": {
"code": 429,
"message": "Too Many Requests"
}
}Create Audit Log report POST
This endpoint initiates the generation of an audit log report for a specified time frame. Reports are generated asynchronously and, once ready, can be downloaded as CSV files from `/reports/{id}/download`. Use `/reports/{id}` to monitor the report's status. The period between `startDate` and `endDate` must not exceed 92 days, allowing for quarterly reports. Specifying a `customerId` filters the report to include data exclusively for that merchant. Without a `customerId`, the report covers all merchants in your customer hierarchy. If a ```allowEmpty``` is **not** provided or is set to ```false``` the report is **not** generated when there is no available entries and an error is returned.
Create Payment report POST
This endpoint allows you to request a payment report for a specific period. Once requested, your report will be generated asynchronously and available at the ```/reports/id/download endpoint``` as a CSV file once it's been generated. Check on the availability status of your report using the ```/reports/{id}``` endpoint. The ```startDate``` and ```endDate``` may be a maximum of **92 days** apart, so you can generate reports containing 3 months data. If you supply a ```customerId``` for any merchant within your customer hierarchy, only that merchant's data will be returned. If a ```customer ID``` is **not** provided, the report will contain data for all merchants within your customer hierarchy. If a ```allowEmpty``` is **not** provided or is set to ```false``` the report is **not** generated when there is no available entries and an error is returned.