Create Payouts report
This endpoint allows you to request a payouts 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 you supply an accountId for Connect account, only data related to this account will be returned.
If an account ID is not provided, the report will contain data related to all Connect accounts.
Authorization
oauth OAuth2 password grant - see the documentation in the oAuth2 Authentication section
In: header
Request Body
application/json
From which date payouts data should be gathered (in error response exists as filters.createdAt.gte)
date-timeTo which date payouts data should be gathered (in error response exists as filters.createdAt.lte)
date-timeuuidFilter payouts from particular connect account.
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.sandbox.volt.io/reports/payouts" \ -H "Content-Type: application/json" \ -d '{ "startDate": "2019-08-24T14:15:22+00:00", "endDate": "2019-08-24T14:15:22+00:00", "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac", "accountId": "12d8e330-2878-4742-a86f-dbbb3bf52234" }'{
"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 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.
Create Refund report POST
This endpoint allows you to request a refund 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 you supply an ```accountId``` for Connect account, only data related to this account will be returned. If an ```account ID``` is **not** provided, the report will contain data related to all Connect accounts.