1.2 Transactional Data Files
Thredd can supply you with daily transaction-related data reports in the XML file format. The files are delivered to you via sFTP.
Bear in mind that if you need to keep transaction records over time, you must follow the right business processes for maintaining the records.
1.2.1 XML File Contents
File contents include either the Clearing Report or the Non-Clearing Report.
Clearing Report
The Clearing Report contains all the available presentments on the Thredd platform, which have been received and processed at the Initiation Time. This is data that is used for clearing. For an example of a Clearing Report, see Clearing Transaction Report Example.
Non-Clearing Report
The Non-Clearing Report contains authorisation, load, unload and fee data on the Thredd platform. This data is received and processed at the Initiation Time. For an example of a Non-Clearing Report, see Non-Clearing Transaction Report Example.
1.2.2 File Sending Schedule
Thredd can send files of generated reports at a time that meets your business requirements. For each report type, you can choose the From, To and Initiation Time settings. The following table summarises the time settings:
|
Time |
Description |
|---|---|
|
Initiation Time |
The time of day you select for Thredd to start the generation of an individual report. |
|
To Time |
The latest time threshold/end interval during the day for the timestamp transactions to be included in the report. Initiation Time is always >= to the To Time. |
|
From Time |
The earliest time threshold/start interval during the day for timestamp transactions to be included in the report. By default, From Time = To Time over a 24h period. |
|
Generation Time |
The time needed to produce a report, spanning between Initiation Time and the time when the XML file for the report has been created. |
|
Transportation Time |
Disk and network time needed to copy a readily available XML file/report to the client sFTP folder. |
|
Delivery Time |
The time when the XML file/report is available in the client's sFTP folder for pick-up. |
Generation and Transportation Times determine the Delivery Time of the report. The Delivery Time depends on the number or volume of transactions in the file that passed from the report Initiation Time.
By default, Thredd use the following logic for the reports:
-
Non-Clearing Report — By default, the Initiation Time is after midnight in your selected timezone. The From Time is 00:00 of the previous day (D-1) in relation to the Initiation Time. The To Time is 23:59 of the previous day (D-1) in relation to the report Initiation Time.
-
Clearing Report — The Initiation, From and To Times are selectable (From Time = To Time over a 24h period).
Card Scheme (Payment Network) and Gateway Provider Considerations
If you want your Clearing Reports to include Visa and Mastercard transactions, you need to consider the clearing cycles for these card schemes (payment networks). The clearing cycles can influence the XML file sending schedule from Thredd for the Clearing Reports. For MNE
A US PIN debit network provider for opening access to US debit networks.1 gateway transactions, the clearing cycles do not apply. This is because MNE sends transactions that are SMS messages, where authorisation and clearing data are in the same message. When Thredd sends to you MNE transactions data, these are included within Non-Clearing Reports.
The clearing cycles are summarised as follows:
- Mastercard — There are 6 clearing cycles per day, seven days per week. After each clearing cycle, Mastercard sends Thredd clearing files, which contain the settlement data. Data from cycles 5-6 from the night before and 1-4 from current day form a compete settlement day picture for most regions. These contain all the information you need to reconcile your settlements with Mastercard.
-
Visa — Visa provide 2 clearing files (Domestic and International) each day. For International visa cycles, different timings exist for some regions (For example, Australia and Hong Kong). There is a maximum file size where, for the largest clients, it is possible that more than one Domestic and/or International file will be received on the same day. Visa domestic cycles start at 9 am, while international cycles start at mid-day. The clearing cycles occur for 7 days a week.
1.2.3 File Naming Convention
The transaction report files that you receive from Thredd use the following naming convention:
|
Type of Report |
Environment |
Naming Convention |
|---|---|---|
|
Non-Clearing Report |
PX |
|
|
Clearing Report |
PX |
|
Where:
-
THRD — Abbreviation for Thredd.
-
PPPP — Programme manager code or name.
-
NCLR — Report code. NCLR is for a Non-Clearing file and CLR is for a clearing file.
-
YYYYMMDDHHMM — From Time, first occurance after report code. This includes YYYY for year (4 digits), MM for month (2 digits) and DD for day (2 digits).
-
YYYYMMDDHHMM — To Time, second occurance after report code). This includes YYYY for year (4 digits), MM for month (2 digits) and DD for day (2 digits).
-
PX - Thredd production environment used to generate the report, value of X indicating the exact environment.
Non-Clearing and Clearing Report Examples
The following shows examples of files for a Non-Clearing Report and Clearing Report.
|
Example |
Type of Report |
Description |
|---|---|---|
|
|
Non-Clearing Report |
This file includes a snapshot of all non-clearing transactions recorded for the ABC program manager, available on the Thredd platform. The file includes the respective statuses at the report Initiation Time with a timestamp between the 25th of January 2024, 00:00 and the 26th of January 2024, 00:00 on Thredd's Production 1 environment. |
|
|
Clearing Report |
This file includes a snapshot of all clearing transactions recorded for the ABCD program manager, available on the Thredd platform. This file includes the respective statuses at the report Initiation Time with a timestamp between the 15th of February 2024, 14:00 and the 16th of February 2024, 14:00 on Thredd's Production 2 environment. |
For details on which production environment applies to your programme, check with your Thredd implementation manager or account manager.
1.2.4 Encryption and Encoding
XML files are encrypted using PGP
Pretty Good Privacy (PGP) is an encryption system used for both sending encrypted emails and encrypting sensitive files., which requires the sharing of keys. For details, contact your implementation manager.
All of the XML data files are well-formed XML (UTF-8 encoded).
As XML is case-sensitive, you should ensure that you follow the correct casing for all XML elements and attribute names when processing the message.