GuidesAPI Reference
HomeGuidesAPI Reference
GuidesAPI ReferenceLog In
Guides

Reporting API Requests

Use these reporting requests to integrate reports into your financial host system.

Use the Schedule Report request to create and schedule reports. Use the List Reports request to view available reports and the Get Report Details to retrieve report information. If a report fails, use the Retry Failed Report request to run it again.

Here's a list of reporting requests supported in the service:

RequestEndpointMethodDescription
Schedule Report/api/v3/reportsPOST

This request creates and schedules a report in one of two ways, each with different parameters and outputs:

• Vertex O Series Cloud Online Commerce
• Standalone Vertex Validator

List Reports/api/v3/reportsGETThis request retrieves the reports you create and schedule with the Schedule Report request.
Get Report Details/api/v3/reports/{uuid}GETThis request retrieves the report details for a report.
Retry Failed Report/api/v3/reports/{uuid}/retryPOSTThis request attempts to create and schedule a report again if the attempt in the Schedule Report request is unsuccessful.

For more information about the fields in the reports and their descriptions, see Reporting API Field References.