Scheduled and ad hoc

The Reporting API allows you to schedule and customize the frequency of your reports as per your needs.

Before you begin

Determine the integration option you want to use:

Entity

Entity defines the level of the merchant relationship as it relates to the acquiring account. Contact your relationship manager to know your entity IDs across different entity types. Determine the entity type you want to use in the report configuration from the following:

Entity types
Entity type	Description
PE	Processing Entity
TD	Transaction Division
FTI	Fund Transfer Instruction
BU	Business Unit
CO	Company
RGPE	Reporting group for processing entity
RGTD	Reporting group for transaction division
RGFTI	Reporting group for fund transfer instruction
RGBU	Reporting group for business unit
RGCO	Reporting group for company

For more information on reporting groups, refer to reporting groups and how to manage reporting groups.

Note

A few things to keep in mind for FTI-level reports:

Reports generated using transactional or dispute details report types will have the reporting data aggregated for all the business units associated with the FTI.
- For other report types, the reporting data will remain at the FTI-level.
You cannot create report configurations for multi-sectional FTI-level reports that include both transactional and non-transactional reporting data across different sections.

Scheduling reports

The Reporting API uses the standard UTC format for all times and timestamps.

The following table shows the fields that are used for scheduling a report:

Fields for scheduling a report
Field name	Description	Valid values
`scheduleFrequency`	Specifies frequency of the report schedule.	daily — Running a report every day. weekly — Running a report every Tuesday would be weekly\|tue. monthly — Running a report on the 3rd day following the end of the month would be monthly\|3. monthly-fiscal — Running a report based on your fiscal calendar. mtd — Running a report from the start of the month to the current date. adhoc — Running a report on a custom schedule.
`reportFileScheduleTime`	Specifies when report generation should begin, not when the report has completed. Applies only for daily, weekly, monthly, Month to date (mtd), and monthly-fiscal.	Time in UTC time zone. The value is set by the system based on your merchant end-of-day time (MEOD) even if you pass a value in the request.
`reportingPeriodStartTime`	Specifies the starting point for data collection.	Your merchant end-of-day time (MEOD) in UTC time zone. The value is set by the system based on your merchant end-of-day time (MEOD) even if you pass a value in the request.
`reportingPeriodStartTimestamp`	Specifies the starting point for data collection. Applies only for ad hoc.	Time in UTC time zone.
`reportingPeriodEndTimestamp`	Specifies the ending point for data collection. Applies only for ad hoc.	Time in UTC time zone.

Note

You can update the schedule frequency on an existing report configuration at any time.
You can configure a maximum of 20 unique report configurations per entity ID using the Reporting API.

Daily schedule

Schedule daily reports by setting scheduleFrequency to daily. The reportFileScheduledTime and reportingPeriodStartTime are set by the system based on your merchant end-of-day time (MEOD).

The following table shows how the daily schedule works based on your MEOD.

Daily schedule examples per MEOD
MEOD (EST)	Report availability by (EST)	reportingPeriodStartTime	reportFileScheduledTime	Example for daily frequency
MEOD (EST)	Report availability by (EST)	(in UTC i.e. MEOD in EST+5 hours; set by the system)	(in UTC, set by the system)	(scheduleFrequency = daily)
12:00 AM	1:00 PM	05:00:00	15:00:00	Report Generation Date = 5/21 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/20 12AM EST to 5/21 12AM EST
1:00 AM	1:00 PM	06:00:00	15:00:00	Report Generation Date = 5/21 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/20 1AM EST to 5/21 1AM EST
2:00 AM	1:00 PM	07:00:00	15:00:00	Report Generation Date = 5/21 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/20 2AM EST to 5/21 2AM EST
3:00 AM	1:00 PM	08:00:00	15:00:00	Report Generation Date = 5/21 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/20 3AM EST to 5/21 3AM EST
4:00 AM	1:00 PM	09:00:00	15:00:00	Report Generation Date = 5/21 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/20 4AM EST to 5/21 4AM EST
5:00 AM	1:00 PM	10:00:00	15:00:00	Report Generation Date = 5/21 Report Availability Time = 1 PM EST Reporting data will include activity from 5/20 5AM EST to 5/21 5AM EST
6:00 AM	5:00 PM	11:00:00	20:00:00	Report Generation Date = 5/21 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/20 6AM EST to 5/21 6AM EST
7:00 AM	5:00 PM	12:00:00	20:00:00	Report Generation Date = 5/21 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/20 7AM EST to 5/21 7AM EST
8:00 AM	5:00 PM	13:00:00	20:00:00	Report Generation Date = 5/21 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/20 8AM EST to 5/21 8AM EST
9:00 AM	5:00 PM	14:00:00	20:00:00	Report Generation Date = 5/21 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/20 9AM EST to 5/21 9AM EST
10:00 AM	5:00 PM	15:00:00	20:00:00	Report Generation Date = 5/21 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/20 10AM EST to 5/21 10AM EST
11:00 AM	1:00 AM	16:00:00	3:00:00	Report Generation Date = 5/21 Report Availability Time = 1 AM EST Reporting data will include activity from: 5/19 11AM EST to 5/20 11AM EST
12:00 PM	1:00 AM	17:00:00	3:00:00	Report Generation Date = 5/21 Report Availability Time = 1 AM EST Reporting data will include activity from: 5/19 12PM EST to 5/20 12PM EST
1:00 PM	1:00 AM	18:00:00	3:00:00	Report Generation Date = 5/21 Report Availability Time = 1 AM EST Reporting data will include activity from: 5/19 1PM EST to 5/20 1PM EST
2:00 PM	1:00 AM	19:00:00	3:00:00	Report Generation Date = 5/21 Report Availability Time = 1 AM EST Reporting data will include activity from: 5/19 2PM EST to 5/20 2PM EST
3:00 PM	1:00 AM	20:00:00	3:00:00	Report Generation Date = 5/21 Report Availability Time = 1 AM EST Reporting data will include activity from: 5/19 3PM EST to 5/20 3PM EST
4:00 PM	1:00 AM	21:00:00	3:00:00	Report Generation Date = 5/21 Report Availability Time = 1 AM EST Reporting data will include activity from: 5/19 4PM EST to 5/20 4PM EST
5:00 PM	1:00 AM	22:00:00	3:00:00	Report Generation Date = 5/21 Report Availability Time = 1 AM EST Reporting data will include activity from: 5/19 5PM EST to 5/20 5PM EST
6:00 PM	8:00 AM	23:00:00	10:00:00	Report Generation Date = 5/21 Report Availability Time = 8 AM EST Reporting data will include activity from: 5/19 6PM EST to 5/20 6PM EST
7:00 PM	8:00 AM	24:00:00	10:00:00	Report Generation Date = 5/21 Report Availability Time = 8 AM EST Reporting data will include activity from: 5/19 7PM EST to 5/20 7PM EST
8:00 PM	8:00 AM	01:00:00	10:00:00	Report Generation Date = 5/21 Report Availability Time = 8 AM EST Reporting data will include activity from: 5/19 8PM EST to 5/20 8PM EST
9:00 PM	8:00 AM	02:00:00	10:00:00	Report Generation Date = 5/21 Report Availability Time = 8 AM EST Reporting data will include activity from: 5/19 9PM EST to 5/20 9PM EST
10:00 PM	8:00 AM	03:00:00	10:00:00	Report Generation Date = 5/21 Report Availability Time = 8 AM EST Reporting data will include activity from: 5/19 10PM EST to 5/20 10PM EST
11:00 PM	8:00 AM	04:00:00	10:00:00	Report Generation Date = 5/21 Report Availability Time = 8 AM EST Reporting data will include activity from: 5/19 11PM EST to 5/20 11PM EST

Weekly schedule

Schedule weekly reports by setting scheduleFrequency to weekly|(day of the week). You can specify the day of the week when the report should be generated.

The reportFileScheduledTime and reportingPeriodStartTime are set by the system based on your merchant end-of-day time (MEOD).

The following table shows how the weekly schedule works based on your MEOD.

Weekly schedule examples by MEOD
MEOD (EST)	Report availability by (EST)	reportingPeriodStartTime	reportFileScheduledTime	Examples for weekly frequency	Examples for weekly frequency
MEOD (EST)	Report availability by (EST)	(in UTC i.e. MEOD in EST+5 hours, set by the system)	(in UTC, set by the system)	(scheduleFrequency = weekly\|mon)	(scheduleFrequency = weekly\|wed)
12:00 AM	1:00 PM	05:00:00	15:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 PM EST Reporting data will include activity from: 5/12 12AM EST Mon to 5/19 12AM EST Mon	Report Generation Date = 5/21 Mon Report Availability Time = 1 PM EST Reporting data will include activity from: 5/14 12AM EST Wed to 5/21 12AM EST Wed
1:00 AM	1:00 PM	06:00:00	15:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 PM EST Reporting data will include activity from: 5/12 1AM EST Mon to 5/19 1AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 1 PM EST Reporting data will include activity from: 5/14 1AM EST Mon to 5/21 1AM EST Wed
2:00 AM	1:00 PM	07:00:00	15:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 PM EST Reporting data will include activity from: 5/12 2AM EST Mon to 5/19 2AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 1 PM EST Reporting data will include activity from: 5/14 2AM EST Wed to 5/21 2AM EST Wed
3:00 AM	1:00 PM	08:00:00	15:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 PM EST Reporting data will include activity from: 5/12 3AM EST Mon to 5/19 3AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 1 PM EST Reporting data will include activity from: 5/14 3AM EST Wed to 5/21 3AM EST Wed
4:00 AM	1:00 PM	09:00:00	15:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 PM EST Reporting data will include activity from: 5/12 4AM EST Mon to 5/19 4AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 1 PM EST Reporting data will include activity from: 5/14 4AM EST Wed to 5/21 4AM EST Wed
5:00 AM	1:00 PM	10:00:00	15:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 PM EST Reporting data will include activity from: 5/12 5AM EST Mon to 5/19 5AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 1 PM EST Reporting data will include activity from: 5/14 5AM EST Wed to 5/21 5AM EST Wed
6:00 AM	5:00 PM	11:00:00	20:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 5 PM EST Reporting data will include activity from: 5/12 6AM EST Mon to 5/19 6AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 5 PM EST Reporting data will include activity from: 5/14 6AM EST Wed to 5/21 6AM EST Wed
7:00 AM	5:00 PM	12:00:00	20:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 5 PM EST Reporting data will include activity from: 5/12 7AM EST Mon to 5/19 7AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 5 PM EST Reporting data will include activity from: 5/14 7AM EST Wed to 5/21 7AM EST Wed
8:00 AM	5:00 PM	13:00:00	20:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 5 PM EST Reporting data will include activity from: 5/12 8AM EST Mon to 5/19 8AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 5 PM EST Reporting data will include activity from: 5/14 8AM EST Wed to 5/21 8AM EST Wed
9:00 AM	5:00 PM	14:00:00	20:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 5 PM EST Reporting data will include activity from: 5/12 9AM EST Mon to 5/19 9AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 5 PM EST Reporting data will include activity from: 5/14 9AM EST Wed to 5/21 9AM EST Wed
10:00 AM	5:00 PM	15:00:00	20:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 5 PM EST Reporting data will include activity from: 5/12 10AM EST Mon to 5/19 10AM EST Mon	Report Generation Date = 5/21 Wed Report Availability Time = 5 PM EST Reporting data will include activity from: 5/14 10AM EST Wed to 5/21 10AM EST Wed
11:00 AM	1:00 AM	16:00:00	3:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 AM EST Reporting data will include activity from: 5/11 11AM EST Sun to 5/18 11AM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 1 AM EST Reporting data will include activity from: 5/13 11AM EST Tue to 5/20 11AM EST Tue
12:00 PM	1:00 AM	17:00:00	3:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 AM EST Reporting data will include activity from: 5/11 12PM EST Sun to 5/18 12PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 1 AM EST Reporting data will include activity from: 5/13 12PM EST Tue to 5/20 12PM EST Tue
1:00 PM	1:00 AM	18:00:00	3:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 AM EST Reporting data will include activity from: 5/11 1PM EST Sun to 5/18 1PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 1 AM EST Reporting data will include activity from: 5/13 1PM EST Tue to 5/20 1PM EST Tue
2:00 PM	1:00 AM	19:00:00	3:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 AM EST Reporting data will include activity from: 5/11 2PM EST Sun to 5/18 1PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 1 AM EST Reporting data will include activity from: 5/13 2PM EST Tue to 5/20 1PM EST Tue
3:00 PM	1:00 AM	20:00:00	3:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 AM EST Reporting data will include activity from: 5/11 3PM EST Sun to 5/18 3PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 1 AM EST Reporting data will include activity from: 5/13 3PM EST Tue to 5/20 3PM EST Tue
4:00 PM	1:00 AM	21:00:00	3:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 AM EST Reporting data will include activity from: 5/11 3PM EST Sun to 5/18 4PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 1 AM EST Reporting data will include activity from: 5/13 3PM EST Tue to 5/20 4PM EST Tue
5:00 PM	1:00 AM	22:00:00	3:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 1 AM EST Reporting data will include activity from: 5/11 5PM EST Sun to 5/18 5PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 1 AM EST Reporting data will include activity from: 5/13 5PM EST Tue to 5/20 5PM EST Tue
6:00 PM	8:00 AM	23:00:00	10:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 8 AM EST Reporting data will include activity from: 5/11 6PM EST Sun to 5/18 6PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 8 AM EST Reporting data will include activity from: 5/13 6PM EST Tue to 5/20 6PM EST Tue
7:00 PM	8:00 AM	24:00:00	10:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 8 AM EST Reporting data will include activity from: 5/11 7PM EST Sun to 5/18 7PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 8 AM EST Reporting data will include activity from: 5/13 7PM EST Tue to 5/20 7PM EST Tue
8:00 PM	8:00 AM	01:00:00	10:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 8 AM EST Reporting data will include activity from: 5/11 7PM EST Sun to 5/18 7PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 8 AM EST Reporting data will include activity from: 5/13 7PM EST Tue to 5/20 7PM EST Tue
9:00 PM	8:00 AM	02:00:00	10:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 8 AM EST Reporting data will include activity from: 5/11 9PM EST Sun to 5/18 9PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 8 AM EST Reporting data will include activity from: 5/13 9PM EST Tue to 5/20 9PM EST Tue
10:00 PM	8:00 AM	03:00:00	10:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 8 AM EST Reporting data will include activity from: 5/11 10PM EST Sun to 5/18 10PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 8 AM EST Reporting data will include activity from: 5/13 10PM EST Tue to 5/20 10PM EST Tue
11:00 PM	8:00 AM	04:00:00	10:00:00	Report Generation Date = 5/19 Mon Report Availability Time = 8 AM EST Reporting data will include activity from: 5/11 11PM EST Sun to 5/18 11PM EST Sun	Report Generation Date = 5/21 Wed Report Availability Time = 8 AM EST Reporting data will include activity from: 5/13 11PM EST Tue to 5/20 11PM EST Tue

Monthly schedule

Schedule monthly reports by setting scheduleFrequency to monthly|(day of the month). You can specify the day of the month when the report should be generated. This cannot be greater than 28, meaning a report cannot be scheduled to run on the 29th day of every month.

The reportFileScheduledTime and reportingPeriodStartTime are set by the system based on your merchant end-of-day time (MEOD).

The following table shows how the weekly schedule works based on your MEOD.

Monthly schedule examples by MEOD
MEOD (EST)	Report availability by (EST)	reportingPeriodStartTime	reportFileScheduledTime	Examples for monthly frequency	Examples for monthly frequency
MEOD (EST)	Report availability by (EST)	(in UTC i.e. MEOD in EST+5 hours; set by the system)	(in UTC, set by the system)	(scheduleFrequency = monthly\|1)	(scheduleFrequency = monthly\|3)
12:00 AM	1:00 PM	05:00:00	15:00:00	Report Generation Date = 6/1 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 12AM EST to 6/1 12AM EST	Report Generation Date = 6/3 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 12AM EST to 6/1 12AM EST
1:00 AM	1:00 PM	06:00:00	15:00:00	Report Generation Date = 6/1 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 1AM EST to 6/1 1AM EST	Report Generation Date = 6/3 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 1AM EST to 6/1 1AM EST
2:00 AM	1:00 PM	07:00:00	15:00:00	Report Generation Date = 6/1 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 2AM EST to 6/1 2AM EST	Report Generation Date = 6/3 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 2AM EST to 6/1 2AM EST
3:00 AM	1:00 PM	08:00:00	15:00:00	Report Generation Date = 6/1 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 3AM EST to 6/1 3AM EST	Report Generation Date = 6/3 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 3AM EST to 6/1 3AM EST
4:00 AM	1:00 PM	09:00:00	15:00:00	Report Generation Date = 6/1 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 4AM EST to 6/1 4AM EST	Report Generation Date = 6/3 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 4AM EST to 6/1 4AM EST
5:00 AM	1:00 PM	10:00:00	15:00:00	Report Generation Date = 6/1 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 5AM EST to 6/1 5AM EST	Report Generation Date = 6/3 Report Availability Time = 1 PM EST Reporting data will include activity from: 5/1 5AM EST to 6/1 5AM EST
6:00 AM	5:00 PM	11:00:00	20:00:00	Report Generation Date = 6/1 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 6AM EST to 6/1 6AM EST	Report Generation Date = 6/3 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 6AM EST to 6/1 6AM EST
7:00 AM	5:00 PM	12:00:00	20:00:00	Report Generation Date = 6/1 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 7AM EST to 6/1 7AM EST	Report Generation Date = 6/3 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 7AM EST to 6/1 7AM EST
8:00 AM	5:00 PM	13:00:00	20:00:00	Report Generation Date = 6/1 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 8AM EST to 6/1 8AM EST	Report Generation Date = 6/3 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 8AM EST to 6/1 8AM EST
9:00 AM	5:00 PM	14:00:00	20:00:00	Report Generation Date = 6/1 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 9AM EST to 6/1 9AM EST	Report Generation Date = 6/3 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 9AM EST to 6/1 9AM EST
10:00 AM	5:00 PM	15:00:00	20:00:00	Report Generation Date = 6/1 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 10AM EST to 6/1 10AM EST	Report Generation Date = 6/3 Report Availability Time = 5 PM EST Reporting data will include activity from: 5/1 10AM EST to 6/1 10AM EST
11:00 AM	1:00 AM	16:00:00	3:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 11AM EST to 5/31 11AM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 11AM EST to 5/31 11AM EST
12:00 PM	1:00 AM	17:00:00	3:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 12AM EST to 5/31 12AM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 12AM EST to 5/31 12AM EST
1:00 PM	1:00 AM	18:00:00	3:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 1PM EST to 5/31 1PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 1PM EST to 5/31 1PM EST
2:00 PM	1:00 AM	19:00:00	3:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 2PM EST to 5/31 2PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 2PM EST to 5/31 2PM EST
3:00 PM	1:00 AM	20:00:00	3:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 3PM EST to 5/31 3PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 3PM EST to 5/31 3PM EST
4:00 PM	1:00 AM	21:00:00	3:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 4PM EST to 5/31 4PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 4PM EST to 5/31 4PM EST
5:00 PM	1:00 AM	22:00:00	3:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 5PM EST to 5/31 5PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 5PM EST to 5/31 5PM EST
6:00 PM	8:00 AM	23:00:00	10:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 6PM EST to 5/31 6PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 6PM EST to 5/31 6PM EST
7:00 PM	8:00 AM	24:00:00	10:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 7PM EST to 5/31 7PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 7PM EST to 5/31 7PM EST
8:00 PM	8:00 AM	01:00:00	10:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 8PM EST to 5/31 8PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 8PM EST to 5/31 8PM EST
9:00 PM	8:00 AM	02:00:00	10:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 9PM EST to 5/31 9PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 9PM EST to 5/31 9PM EST
10:00 PM	8:00 AM	03:00:00	10:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 10PM EST to 5/31 10PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 10PM EST to 5/31 10PM EST
11:00 PM	8:00 AM	04:00:00	10:00:00	Report Generation Date = 6/1 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 11PM EST to 5/31 11PM EST	Report Generation Date = 6/3 Report Availability Time = 1 AM EST Reporting data will include activity from: 4/30 11PM EST to 5/31 11PM EST

Monthly-fiscal schedule

Schedule monthly reports according to your specific fiscal schedules to aid in the reconciliation of reports based on your business calendar by using scheduleFrequency: monthly-fiscal.

A few things to keep in mind:

The reportFileScheduledTime and reportingPeriodStartTime are set by the system based on your merchant end-of-day time (MEOD) and fiscal calendar.
Supported for 3000 series report types only.
Entity types PE and RGPE are not supported, and will throw a validation error if used.
You must have a fiscal calendar available when generating reports. If the calendar is deleted after the first execution, the next execution will not be triggered until the fiscal calendar is replaced.

Note

For adding a fiscal calendar or editing an existing fiscal calendar, contact your relationship manager.

The following table shows how monthly-fiscal reports work:

Monthly-fiscal report examples
MEOD (EST)	Fiscal start date	Fiscal end date	Montly-fiscal report details
10 PM	1-Jan	25-Jan	Report generation date: 26th Jan Report contains data from: 1st Jan 10 PM EST to 25th Jan 10 PM EST
10 PM	25-Jan	25-Feb	Report generation: 26th Feb Report contains data from: 25th Jan 10 PM EST to 25th Feb 10 PM EST

Month to date (MTD) schedule

Generate reports that contain data from the start of the month to the current date (report generation date) or current date-1 based on your merchant end-of-day time (MEOD) by using scheduleFrequency: mtd.

A few things to keep in mind:

The reportFileScheduledTime and reportingPeriodStartTime are set by the system based on your MEOD.
You can choose to have rolling data for the desired time period on your reports.
- For example , when a report is scheduled with scheduleFrequency: mtd
  - If a report runs on the 17th of a month , then it will have data from the beginning of the month till the current date or current date-1 based on MEOD.
  - If a report runs on the 30th of a month , then it will have data from the beginning of the month till the current date or current date-1 based on MEOD.
Rolling data feature is available for all the report types and entities.

Note

MTD conditions for Settlement summary report type - The report will have fund transfers corresponding to the report start time (start of the current month) and end time calculated as per MTD and MEOD without any repetitions.
MTD conditions for Dispute Details v2 report type - The report will have the correct inventory data corresponding to the reporting start time (start of the current month) and end time calculated as per MTD and MEOD.

The following table shows how MTD reports work:

MTD report examples
MEOD (EST)	Report generation date	MTD report details
9 AM	19-Jun	Report availability time: 5 PM EST Report contains data from: 1st June 9 AM EST to 19th June 9 AM EST.
10 PM	20-Jun	Report availability time: 8 AM EST Report contains data from: 1st June 10 PM EST to 19th June 10 PM EST.

Report lag

Report Lag feature allows you to delay the report generation by a couple of days to accommodate the late arrival of information.

A few things to keep in mind:

Report generation can be delayed up to a maximum of 5 days.
Report lag is supported only for reports with daily frequency. (not supported for weekly, monthly, mtd, and monthly-fiscal)
Available for all report types and entities.

The following table shows an example of how report lag works on daily reports:

Report lag on reports examples
MEOD (EST)	scheduleFrequency	reportLag	Report details
10 PM	daily	2	Report generation date: 6/17 (the original daily report generation date of 6/15 was incremented by 2 due to report lag) Report availability Time: 8 AM EST Report contains data from: 13th June 10 PM EST to 14th June 10 PM EST
9 AM	daily	4	Report generation date: 6/18 (the original daily report generation date of 6/14 was incremented by 4 due to report lag) Report availability Time: 5 PM EST Report contains data from: 13th June 9 AM EST to 14th June 9 AM EST

Ad hoc

Ad hoc is used to run scheduled reports on custom date ranges instead of daily, weekly, or monthly by setting scheduleFrequency to adhoc.

You can control starting and ending point for data collection by using the fields reportingPeriodStartTimestamp and reportingPeriodEndTimestamp.
You must adjust the time based on Day Light Savings (DST).

The following table shows examples of how the calculation works.

Examples of ad hoc report configurations
MEOD	reportingPeriodStartTimestamp	reportingPeriodEndTimestamp	Report generation date	Reporting data
3 AM UTC	2nd Sept - 3 AM UTC	9th Sept - 3 AM UTC	9-Sep	From 2nd Sept 3 AM to 9th Sept 3 AM

For example, the below ad hoc report will include data from 2nd September to 9th September:

HTTP method: POST

Endpoint: /reports

Json

{
     "frequencyConfig": {  
          "scheduleFrequency": "adhoc",  
          "reportingPeriodStartTimestamp": "2024-09-02 03:00:00",  
          "reportingPeriodEndTimestamp": "2024-09-09 02:59:59"  
     }
}

At any point, you can change the ad hoc frequency configuration when triggering the report to run. This does not require updating the report configuration first.

Note

You can generate adhoc reports for the last 6 months of data from the current date.

Handling daylight saving time

Reporting handles daylight saving time (DST) differently for scheduled and ad hoc reports.

Scheduled Reports (Daily/Weekly/Monthly): Our system automatically adjusts for Daylight Saving Time when generating scheduled reports. This means you can rely on the system to deliver your reports at the expected times without any additional action required on your part.
Ad hoc Reports: You need to manually convert timestamps to UTC. This ensures that the data you receive accurately reflects the intended time period, taking into account any DST changes. We recommend verifying the time adjustments during the DST transition periods to ensure the accuracy of your ad hoc reports.

Examples

The following examples will help you better understand how to handle DST in ad hoc reports.

During DST (March to November)

Let’s say your merchant end-of-day (MEOD) is set to 10 PM EST during DST, then you must update your reportingPeriodStartTimestamp to 3 AM UTC during DST.

HTTP method: PUT

Endpoint: /report-configs/{report-configuration-id}

Scenario: Scheduling an ad hoc monthly report for April.

codeblock-dst-1

Json

{
    "frequencyConfig": {
        "scheduleFrequency": "adhoc",
        "reportingPeriodStartTimestamp": "2024-04-01 03:00:00",
        "reportingPeriodEndTimestamp": "2024-05-01 02:59:59"
    }
}

After Daylight Saving Time (November to March)

Let’s say your merchant end-of-day (MEOD) is set to 10 PM EST after DST, then you must update your reportingPeriodStartTimestamp to 2 AM UTC (standard time) after DST.

HTTP method: PUT

Endpoint: /report-configs/{report-configuration-id}

Scenario: Scheduling an ad hoc monthly report for December.

codeblock-dst-2

Json

{
    "frequencyConfig": {
        "scheduleFrequency": "adhoc",
        "reportingPeriodStartTimestamp": "2024-12-01 02:00:00",
        "reportingPeriodEndTimestamp": "2025-01-01 01:59:59"
    }
}

Transition from Standard Time to DST (March)

Let's say your merchant end-of-day (MEOD) is 10 PM EST during March, then you must update your reportingPeriodEndTimestamp from 2 AM UTC (standard time) to 3 AM UTC (DST).

HTTP method: PUT

Endpoint: /report-configs/{report-configuration-id}

Scenario: Scheduling an ad hoc monthly report for March.

codeblock-dst-4

Json

{
    "frequencyConfig": {
        "scheduleFrequency": "adhoc",
        "reportingPeriodStartTimestamp": "2024-03-01 02:00:00",
        "reportingPeriodEndTimestamp": "2024-04-01 02:59:59"
    }
}

Transition from DST to Standard Time (November)

Let's say your merchant end-of-day (MEOD) is 10 PM EST during November, then you must update your reportingPeriodEndTimestamp from 3 AM UTC (DST) to 2 AM UTC (standard time).

HTTP method: PUT

Endpoint: /report-configs/{report-configuration-id}

Scenario: Scheduling an ad hoc monthly report for November.

codeblock-dst-3

Json

{
    "frequencyConfig": {
        "scheduleFrequency": "adhoc",
        "reportingPeriodStartTimestamp": "2024-11-01 03:00:00",
        "reportingPeriodEndTimestamp": "2024-12-01 01:59:59"
    }
}

Key Considerations

DST Transition: Pay special attention to the transition periods in March and November, as the conversion between local time (EST) and UTC changes.
Consistency: Ensure that the timestamps you provide for ad hoc reports are consistent with the DST status during the reporting period.

By following these guidelines and examples, you can ensure that your reports accurately reflect the intended time periods, whether DST is in effect or not.

Get a report configuration
Get report configuration details
Update a report configuration
Set up a report schedule
Create advanced customizations

Scheduled and ad hoc

Before you begin

Entity

Scheduling reports

Daily schedule

Weekly schedule

Monthly schedule

Monthly-fiscal schedule

Month to date (MTD) schedule

Report lag

Ad hoc

Handling daylight saving time

Examples

During DST (March to November)

After Daylight Saving Time (November to March)

Transition from Standard Time to DST (March)

Transition from DST to Standard Time (November)

Related