Transaction XML Reporting Guide

This guide describes the structure and contents of the Thredd Transaction XML reports.

Topics covered: ClosedTypes of XML reports, Format of data files, Transaction Matching, XML schema, primary elements, Sub-elements and attributes

You can view and download the latest Thredd XSD schema files for the current and future versions here: Downloads

Current Version

The current version is available in both Online (HTML) and PDF format.

Online (HTML)

PDF

What's Changed?

Version

Transaction XML Reporting Guide

Added new values to the CashType attribute. See Sub-elements and Attributes > CashCode.

Added details of Visa Dispute Reason Codes; added Mastercard Reason Codes 1403 and 1404. See Message Reason Codes.

Guide rebrand to new company name and brand identity.

2.1.4

Older Versions

Older versions are available in PDF format only.

File Name

What's Changed?

Version

Transaction XML Reporting Guide 2.1.3

Added a new attribute called TTI (Transaction Type Identifier) to the Txn element in the CardFinancial record type. See the Txn sub-element.

Updates to the Transaction XML data schemas to change the data type of PresentmentID from unsigned Int to unsigned Long. Added a new currency code value of 157 (CNH) to the ISOCurrencyCode type in the schema file. See Transaction XML Schema.

Added Chinese Offshore Renminbi (currency code CNH) to the list of supported currencies. See Currency Codes.

Updated XML Schema version. Trace auditno attribute changed from required to optional. See PRN-138.

Updated the description of the Trace element to clarify its usage. See Trace.

2.1.3

Transaction XML Reporting Guide 2.1.2

Updated the section Matching Transaction XML Records to EHI Records to remove reference to use of the Trace element as a unique identifier.

Update to the description of the XML report file naming convention. See Transaction Data Files.

Update to description of frequency of XML reports in FAQs section.

Updated the Copyright Statement.

2.12

Transaction XML Reporting Guide 2.1.1

The maximum length of the DE94_Txn_Orig_ID field has been updated to 16. See Transaction XML Schema.

Added a description of the Thredd 16-digit public token.

Updates to the transaction XML filename format to include details of the applicable Production environment. See Transactional Data Files.

Update to the table Matching Transaction XML Records to EHI Records.

 

2.1.1

Transaction XML Reporting Guide 2.1.0

New transaction XML schema 1.45: In the CardAuthorisation record, the Apprcode element has been updated to nillable="true"

Removed element: FXConversion

Added a new Currency Code, SLE, for the new Sierra Leonean leone.

A new record type called VFC (Visa Fee Collection) has been added to the MasterCardFee element. See PRN-85.

The maximum length of the DE94_Txn_Orig_ID data element has been updated to 16. See PRN-85.

2.1.0

Transaction XML Reporting Guide 2.0.9

Updates made to Introduction (QMR section) and Transactional Data Files (Sending of Files section).

In the AgencyAccount element, the sortcode and bankacc attributes have been updated to support alphanumeric characters. See PRN-118.

In the CashCode element, the CashType attribute has been updated to include CHAPS. See PRN-117.

Updated CardEvent to reflect report handling for CardEvent records that exceed 2GB in size. See PRN-120.

2.0.9

Transaction XML Reporting Guide 2.0.8

New WalletTransaction element added to the transaction XML. See PRN-100.

In XSD schema file, changed the type of AuthTxnID from unsignedint to unsignedlong;

Added the two-digit country code SS (South Sudan) to the ISOCountryCode list. See Transaction XML Schema. See PRN-111.

For MasterCardFee, ApprovedAgencyBanking, DeclinedAgencyBanking and DeclinedAgencyBanking, the Desc element can be empty (nillable="true"). See PRN-110.

Correction: the FeeClass type of 0 is a legacy option which will never appear in a transaction XMLrecord and reference to it has been removed from the guide. Updated the description of FeeAmt in the Card Fee element.

Added a link to the Downloads page on the Documentation Portal, where you can view and download upcoming/future schema versions.

2.0.8

Transaction XML Reporting Guide 2.0.7

Processing Code (ProcCode) = 39 is now used to identify an Account Verification transaction. See the TxnCode field in the CardAuthorisation element. See PRN-102.

Clarified that the fee amount (FeeAmt) in the CardFinancial record is the sum total of any rate fee and fixed fee applied to the transaction.

2.0.7

Transaction XML Reporting Guide 2.0.6

Visa Fee Collection (VFC) has been added to the RecordType element of MasterCardFee, and the <DE94_Txn_Orig_ID> element maximum length has increased from 6 to 13. See PRN-85.

The ReportedToSAFE event type has been added to the transaction XML Schema file.

Removed reference to the ResponseFinancial element in the XML Schema.

2.0.6

Transaction XML Reporting Guide 2.0.5

The CardEvent primary element has been updated to include a new ReportedToSAFE event type; this provides a transactionid attribute to identify a SAFE reporting transaction, but will be blank for other event types. For examples, see the Event sub-element. See PRN-75.

2.0.5

Transaction XML Reporting Guide 2.0.4

Added a new primary element FXConversion to indicate Foreign Exchange (FX) rate conversion. This contains the sub-elements BookingType and BookingStatus.

2.0.4

Transaction XML Reporting Guide 2.0.3

Added a new field <LocalDateUTC> to CardAuthorisation and CardFinancial records. This field contains the LocalDateUTC data that Thredd receives from Mastercard and Visa. See PRN-59.

Added new appendix Load Source, which provides updated details of possible values for the source of a Load or Unload request.

Removed value 0 from the type attribute in the FeeClass element, as this value is no longer supported.

Updates to Card Status Codes to include new values G1-G9. See PRN-48.

2.03

Transaction XML Reporting Guide 2.0.2

Updates to include clarification on usage of actioncodeand responsecode fields in the Response element. New <PaymentToken> field added to CardAuthorisation and CardFinancial records to help support Program Manager Apple-Pay Reporting requirements. See PRN-49.

2.0.2

Transaction XML Reporting Guide 2.0.1

Updates to include clarification around transaction reporting times and cycle times. See Transactional Data Files.

Information on XML reports available for issuers. See Introduction.

New details of fields to use for matching transaction XML records to EHI records and matching financials to authorisations. See Transaction Matching.

The BillAmt rate and the SettlementAmt rate has been updated to show 9 decimal places. See PRN-44.

2.0.1

Transaction Reporting Guide 2.0

Major revamp to look and feel and organisation of the guide. Rewrite of content to simplify and make the guide easier to use.

Updates to description of the Amt field.

Added new element : FXConv in CardAuthorisation and CardFinancial primary elements. See PRN-37.

Change to the values of the TxId field in the CardFee record. See PRN-41.

2.0

For versions prior to 2.0 please contact your Account Manager.