Volt Gateway API (legacy)
View OpenAPI Schemas.
Authenticating with the api
Payments
Payment details GET
List payments GET
Payment Match Score GET
New embedded checkout request POST
New payment request POST
Reporting
Download a report GET
Get report by ID GET
Get available reports GET
Create Audit Log report POST
Create Connect report POST
Create Payment report POST
Create Payouts report POST
Create Refund report POST
How is this guide?
Last updated on
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.
oAuth2 password authentication POST
We use the industry-standard oAuth2 authentication to secure our API. ### Information you'll need - Your **Client ID** and **Client Secret** (from the application you created in Fuzebox) - Your **API username** and **password** (from the merchant credentials section in Fuzebox) Step-by-step instructions on how to authenticate are available in our [integration guides](https://docs.volt.io/gateway/authentication/) area.