This guide entails comprehensive information on report schedules, why they are relevant to your integration, and how to create them using our step-by-step guides. If you have specific questions about our infrastructure, please contact your account manager or reach us at support@silverflow.com.

Description

The Silverflow Report Scheduling API allows users to create report schedules that automate the generation of reports. Working similarly to a cron job, a schedule triggers the create report endpoints at predefined times as preferred by the user. You can set a variety of intervals, such as hourly and daily cadences, ensuring your reports are built continuously and automatically.

Why this is useful

Scheduling reports allows you to fully automate the generation of reports, requiring no manual touchpoints by the user. This ensures that you integrate continuously without any mistakes in time parameters, guaranteeing no data is missed across reporting periods.

How to integrate: a step-by-step guide

To set up scheduling for your reports, follow the guide below.

A user can create a new report schedule using the POST /v1/reportSchedules endpoint using the parameters mentioned above. For example, the following request will create a SchemeFeeDetails report on an hourly basis by setting the following parameters. Note that the report will be build in JSON format because of its mimeType.
Users can optionally add distribution objects to automatically distribute reports that are generated by the schedule. See more on distributions here.
After a new report schedule is created, new report entities will be created following the type and cadence interval. To confirm the successful scheduling of the report, the user will receive a 200 response. In the response, you will find the status as active.
To retrieve the report schedule object(s), the user may call the GET /v1/reportSchedules endpoint to list all report schedules or the GET /v1/reportSchedules/{reportScheduleKey} endpoint using the key of the report schedule.
To update a report schedule, users can call the PATCH /v1/reportSchedules/{reportScheduleKey} endpoint. Make sure the “application type” in the header is set to application/merge-patch+json. Note that the fields in the body are optional and can be used depending on what requires an update.
To archive a report schedule, the user may call the DELETE /v1/reportSchedules/{reportScheduleKey} endpoint which will change its status to archived.

Considerations

Please note that the triggerfield on the reportSchedule endpoint behaves differently for various type of reports. Therefore, the data included in the report has a different timeframe. Below you can find some examples on what data is returned for each report:

reportName	Trigger fields	Data returned (UTC)
charges, settlementDetails, reconciliationDetails, schemeFeeDetails, fraudNotifications, disputeHistoryEvents	cadence = `hourly`	`15:00:00` to `15:59:59` on T+0, each hour
charges, settlementDetails, reconciliationDetails, schemeFeeDetails, fraudNotifications, disputeHistoryEvents	cadence = `daily` hour = `15`	`15:00:00` on T-1 to `14:59:59`on T+0, each day, generated between `15:00:00`
networkFundsTransfers	cadence = `daily` hour = `15`	Today’s `fundsTransferDate`, generated at `15:00:00`
merchantPayout	cadence = `daily` hour = `15`	Today's `fundsTransferDate`, generated at `15:00:00`