XML Report Formats
This chapter describes the XML format of the following CyberSource Merchant Account XML reports:
■
Payment Activity Summary
■
Chargeback & Representment Details
■
Purchase & Refund Details
■
Chargeback Analysis
■
Transfer Log
■
Authorization Analysis
See
XML Report DTDs
for the document type definitions (DTDs) for XML reports.
XML Conventions
To understand how a report in XML format is constructed, you need to become familiar with the syntax and the data types used for XML reports.
The Merchant Account Reports described in this guide do not follow the standard CyberSource reporting format; therefore, do not use a namespace as the reports on the Business Center.
Syntax
Each report is described as follows.
Report Declaration
These conventions are used to describe the report:
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE Report SYSTEM URIreference>
HierarchyLevel=CDATA
ReportStartDate=CDATA
ReportEndDate=CDATA>
Element Declaration
These conventions are used to describe the syntax of each XML element:
<Sample Attribute=CDATA>
(Element
(ChoiceOne) | (ChoiceTwo
(
ComplexElement
(RequiredRecurringElement)+
(OptionalElement)?
(OptionalRecurringElement)*
</Sample>
The DTDs for the reports may use a syntax with the ?, +, or * character inside the parentheses. For example, instead of (OptionalElement)?, the DTD may use (OptionalElement?). Either syntax form is acceptable.
Table 13
Syntax Conventions for XML Elements
Convention
Description
<Sample>
Parent of the following elements
Attribute=CDATA
Name of the attribute, followed by the XML data format for the attribute
(Element)
Required element. Must appear only once
(ChoiceOne) | (ChoiceTwo)
Either element <ChoiceOne> or <ChoiceTwo> but not both
(
ComplexElement
)
Element with one or more children
(RequiredRecurringElement)+
Required element. Can appear one or more times
(OptionalElement)?
Optional element. Can appear once or be omitted
(OptionalRecurringElement)*
Optional element. Can appear zero or more times
Data Types and Lengths
This chapter uses the following terms to refer to the data type of each field. The data lengths indicate the maximum length of each field.
■
Alphanumeric: String containing letters, numbers, and special characters (for example, @, #, and %). All text uses UTF-8 character encoding.
■
Boolean: Single character; T for true or F for false.
■
Amount: An amount, including a decimal point if necessary.
■
Date: YYYY-MM-DD, where:
●
YYYY is the four-digit year
●
MM is the two-digit month
●
DD is the two-digit day
■
Date Time: YYYY-MM-DDTHH:MM:SS[+ | -]HH:MM, where:
●
YYYY is the four-digit year.
●
MM is the two-digit month.
●
DD is the two-digit day.
●
THH:MM:SS is the time, with HH representing hours, MM representing minutes, and SS representing seconds.
●
[+ | -]HH:MM is the time zone’s offset from Greenwich Mean Time (GMT), with HH representing hours and MM representing minutes. The number is prefixed by either a plus (+) or minus (-) to indicate whether the offset adds to or subtracts from GMT.
For example, the offset for Pacific Daylight Time is -07:00.
■
Numeric: string containing numbers.
