Request a payments report

You request a payment report with a POST against the report API.

POST /reports/payments

{
    "startDate" : "2023-05-01T00:00:00Z",
    "endDate" : "2023-07-31T23:59:59Z"
}

Request in API docs

Try yourself with our Postman Collection.

Report timeframe

The required fields startDate and endDate define the timeframe for the report. The report includes all payments which were created during the timeframe, on or after startDate and before or on endDate. The maximum for the timeframe is 92 days. This means, you can also request timeframes where both dates are in the past as long as the dates are not more than 92 days apart.

startDate and endDate need to be defined as a timestamp format:

YYYY-MM-DDTHH:MM:SSZ

YYYY: This represents the year using four digits. For example, 2023.
MM: This represents the month using two digits. For example, 08 for August.
DD: This represents the day of the month using two digits. For example, 14.
T: This is a literal character that separates the date portion from the time portion.
HH: This represents the hour using two digits in a 24-hour clock format. For example, 15 for 3:00 PM.
MM: This represents the minute using two digits. For example, 30.
SS: This represents the second using two digits. For example, 45.
Z: This indicates that the time is in Coordinated Universal Time (UTC), also known as Greenwich Mean Time (GMT), with no offset. The “Z” stands for “Zulu time,” which is a term used in aviation and military contexts to refer to UTC time.

Here an example of a complete timestamp in this format:

2023-08-14T15:30:45Z

representing August 14, 2023, at 3:30:45 PM UTC.

Report for a specific customer

If you provide a customerId to the report API the report will only include payments created by this particular Volt customer.

If this field is left blank, the report API uses the API authentication credentials to identify the customer. This will then also not only include payments created by the identified customer but also all payments created by all children (customers part of the hierarchy). The report contains the customerId for you to distinguish between different customers.

POST /reports/payments

{
    "customerId" : "e6707f41-5f9a-4a39-8308-084fb3a8e19b",
    "startDate" : "2023-05-01T00:00:00Z",
    "endDate" : "2023-07-31T23:59:59Z"
}

Response body

Example response for a specific customer

{
    "id": "2f49c894-3edd-4835-a8d2-6862bfa42d51",
    "status": "REQUESTED",
    "createdAt": "2023-08-14T11:23:10+00:00"
}

In the response contains the id for the report, the status and the timestamp when the report was requested.

You need the id for further requests on this report and ultimately to fetch it.

← Previous Reports

Next → Fetch a payments report