![[CyberSource logo]](images/cybslogo.gif)
Search documentation:
|
|
Search documentation: |
| Help Advanced | |
| Published 05/13/2002 |
|
Chapter 2
XML Report Formats
This chapter describes the format of CyberSource XML reports. See Appendix A, "XML Report DTDs" for the document type definitions (DTDs) for XML reports.
XML Conventions
This chapter uses the following conventions to describe the syntax of each XML element:
<Sample Attribute=CDATA> (Element) (ChoiceOne) | (ChoiceTwo) (ComplexElement) (OptionalElement)? (RequiredRecurringElement)+ (OptionalRecurringElement)* </Sample>Table 2 Conventions for XML SyntaxData Types and Lengths
This chapter uses the following terms to refer to the data type of each field:
- Alphanumeric: String containing letters, numbers, and special characters (for example,
@,#, and%). All text uses UTF-8 character encoding.- Boolean: Single character;
Tfor true orFfor false.- Currency: Amount, including a decimal point if necessary.
- Date:
YYYY-MM-DD, where:- DateTime:
YYYY-MM-DDTHH:MM:SS[+|-]HH:MM, where:
YYYYis the four-digit year.MMis the two-digit month.DDis the two-digit day.THH:MM:SSis the time , withHHrepresenting hours,MMrepresenting minutes, andSSrepresenting seconds.[+|-]HH:MMis the time zone's offset from Greenwich Mean Time (GMT), withHHrepresenting hours andMMrepresenting 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.
The data lengths indicate the maximum length of each field.
Payment Batch Detail Report
The Payment Batch Detail Report contains transactions that include any of the following CyberSource applications:
The report includes only transactions that CyberSource has sent to the payment processor.
Note Transactions appear in the Payment Batch Detail Report before funds are transferred to or from your merchant bank account. To determine whether funds have been transferred, you must reconcile the Payment Batch Detail Report with your bank statements.
For more information about reconciling transactions, see the ICS2 Developer's Guide and the Payment Services Planning Guide. Both guides are available on the CyberSource Support Center.
<Report>
The
<Report>element is the root element of the report.Syntax
<Report Name=CDATA Version=NMTOKEN xmlns=CDATA MerchantID=CDATA ReportStartDate=CDATA ReportEndDate=CDATA> (Batches) </Report>Table 3 Attributes of <Report>Table 4 Child Elements of <Report>
<Batches><Batches>
The
<Batches>element contains all of the payment batches that are included in the report.Syntax
<Batches> (Batch)* </Batches>Table 5 Child Elements of <Batches>
<Batch><Batch>
The
<Batch>element contains the requests associated with a payment batch. The element's attributes provide information about the payment batch.Syntax
<Batch BatchID=CDATA BatchDate=CDATA> (Requests) </Batch>Table 6 Attributes of <Batch>
BatchIDBatchDate<Requests>
The
<Requests>element contains all of the requests from a payment batch.Syntax
<Requests> (Request)* </Requests>Table 7 Child Elements of <Requests>
<Request><Request>
The
<Request>element contains information about a payment transaction.Syntax
<Request RequestID=CDATA MerchantReferenceNumber=CDATA> (TransactionReferenceNumber) (PaymentMethod) (CurrencyCode) (Amount) (Application) </Request>Table 8 Attributes of <Request>Table 9 Child Elements of <Request>
<TransactionReferenceNumber><PaymentMethod>
American ExpressCarte BlancheCheckingCorporate CheckingDiners ClubDiscoverEnRouteJALJCBMasterCardMBNA-LOANSavingsSwitchUNKNOWN cardVisaIf your company uses CyberSource to process a private label card, this field can also contain the name of your private label card.<CurrencyCode><Amount><Application>Transaction Detail Report
This report contains summary information about your transactions. It also includes detailed information about your payment and Advanced Fraud Screen transactions.
<Report>
The
<Report>element is the root element of the report.Syntax
<Report MerchantID=CDATA Name=CDATA ReportStartDate=CDATA ReportEndDate=CDATA Version=CDATA xmlns=CDATA> (Requests) </Report>Table 10 Attributes of <Report>Table 11 Child Elements of <Report>
<Requests><Requests>
The
<Requests>element contains all of the requests in the report.Syntax
<Requests> (Request)* </Requests>Table 12 Child Elements of <Requests>
<Request><Request>
The
<Request>element contains information about a single request.Note A request can include multiple CyberSource applications.
Syntax
<Request MerchantReferenceNumber=CDATA RequestDate=CDATA RequestID=CDATA> (BillTo) (ShipTo)? (Shipping)? (PaymentMethod) (LineItems)? (ApplicationReplies) (PaymentData)? (RiskData)? </Request>Table 13 Attributes of <Request>Table 14 Child Elements of <Request>
<BillTo><ShipTo><Shipping><PaymentMethod><LineItems><ApplicationReplies><PaymentData><RiskData><BillTo>
The
<BillTo>element contains information about the billing address and purchaser for the order.Syntax
<BillTo> (FirstName) (LastName) (MiddleName)? (NameSuffix)? (Address1)? (Address2)? (City) (State)? (Zip)? (CompanyName)? (Email) (Country) (Title)? (Phone) (IPAddress)? (HostName)? (UserName)? </BillTo>Table 15 Child Elements of <BillTo>
<FirstName><LastName><MiddleName><NameSuffix><Address1><Address2><City><State><Zip><CompanyName><Email><Country><Title><Phone><IPAddress><HostName><UserName><ShipTo>
The
<ShipTo>element contains information about the shipping address and recipient for the order.Syntax
<ShipTo> (FirstName)? (LastName)? (Address1)? (Address2)? (City)? (State)? (Zip)? (CompanyName)? (Country)? (Phone)? </ShipTo>Table 16 Child Elements of <ShipTo>
<FirstName><LastName><Address1><Address2><City><State><Zip><CompanyName><Country><Phone><Shipping>
The
<Shipping>element contains information about the shipping method and shipping carrier for the order.Syntax
<Shipping> (Method) (Carrier) </Shipping>Table 17 Child Elements of <Shipping>
<Method><Carrier><PaymentMethod>
The
<PaymentMethod>element contains information about the payment method for the order.If a credit card was used for the order, or if no payment method was specified, the
<PaymentMethod>element will contain a<Card>element. If an electronic check was used for the order, the<PaymentMethod>element will contain a<Check>element.Syntax
<PaymentMethod> (Card) | (Check) </PaymentMethod>Table 18 Child Elements of <PaymentMethod>
<Card><Check>Example
<PaymentMethod>Element<PaymentMethod> <Card> ... </Card> </PaymentMethod><Card>
The
<Card>element contains information used to process a credit card.For requests that do not include payment information, all child elements of
<Card>will be empty.Syntax
<Card> (AccountSuffix) (ExpirationMonth) (ExpirationYear) (StartMonth)? (StartYear)? (IssueNumber)? (CardType)? </Card>Table 19 Child Elements of <Card><Card> <AccountSuffix>1111</AccountSuffix> <ExpirationMonth>12</ExpirationMonth> <ExpirationYear>2015</ExpirationYear> <CardType>Visa</CardType> </Card><Check>
The
<Check>element contains information used to process an electronic check.Syntax
<Check> (AccountSuffix) (CheckNumber) </Check>Table 20 Child Elements of <Check>
<AccountSuffix><CheckNumber><LineItems>
The
<LineItems>element contains all of the line items for the order.Note In the ICS2 API, line items are referred to as offers.
Syntax
<LineItems> (LineItem)* </LineItems>Table 21 Child Elements of <LineItems>
<LineItem>The following example includes two separate line items.
<LineItems> <LineItem Number="0"> ... </LineItem> <LineItem Number="1"> ... </LineItem> </LineItems><LineItem>
The
<LineItem>element contains information about a single line item in an order.Note In the ICS2 API, line items are referred to as offers.
Syntax
<LineItem Number=CDATA> (FulfillmentType) (Quantity)? (UnitPrice) (TaxAmount)? (MerchantProductSKU)? (ProductName)? (ProductCode)? </LineItem>Table 22 Attributes of <LineItem>
Number0.
<FulfillmentType><Quantity><UnitPrice><TaxAmount><MerchantProductSKU><ProductName><ProductCode><ApplicationReplies>
The
<ApplicationReplies>element contains reply information for all applications in the request.Syntax
<ApplicationReplies> (ApplicationReply)+ </ApplicationReplies>Table 24 Child Elements of <ApplicationReplies>
<ApplicationReply>Example
<ApplicationReplies>ElementThe following example shows replies for a request that included the ics_auth and ics_score applications.
<ApplicationReplies> <ApplicationReply Name="ics_auth"> ... </ApplicationReply> <ApplicationReply Name="ics_score"> ... </ApplicationReply> </ApplicationReplies><ApplicationReply>
The
<ApplicationReply>element contains reply information for a single CyberSource application. The report includes an<ApplicationReply>element for each application in your request.If one application in a request is declined, it can prevent other applications in the request from being run. You will receive an
<ApplicationReply>element for each application that does not run; however, its child elements will be empty.Syntax
<ApplicationReply Name=CDATA> (RCode) (RFlag) (RMsg) </ApplicationReply>Table 25 Attributes of <ApplicationReply>
NameExample
<ApplicationReply>Element For a Successful Reply<ApplicationReply Name="ics_score"> <RCode>1</RCode> <RFlag>SOK</RFlag> <RMsg>score service was successful</RMsg> </ApplicationReply>Example
<ApplicationReply>Element For an Application That Did Not RunThis example shows an application that did not run because another application in the request failed. See <ApplicationReply> for more information.
<ApplicationReply Name="ics_auth"> <RCode /> <RFlag /> <RMsg /> </ApplicationReply><PaymentData>
The
<PaymentData>element contains detailed information about the result of a payment transaction.Syntax
<PaymentData> (PaymentRequestID) (PaymentProcessor) (Amount) (CurrencyCode) (TotalTaxAmount)? (AuthorizationType)? (AuthorizationCode)? (AVSResult)? (AVSResultMapped)? (CVResult)? (ProcessorResponseCode)? </PaymentData>Table 27 Child Elements of <PaymentData>
<PaymentRequestID><PaymentProcessor><Amount><CurrencyCode><TotalTaxAmount><AuthorizationType>
O: Online authorization. You receive this value for any successful authorization that was settled normally or was not settled at all.V: Verbal authorization. You receive this value if an authorization was settled by providing a verbal authorization code.If the authorization was not successful, or if the processor did not return an authorization code, this element is empty.<AuthorizationCode><AVSResult><AVSResultMapped><CVResult><ProcessorResponseCode><RiskData>
The
<RiskData>element contains detailed information about the result of a risk transaction.If you use Smart Authorization, some reply fields for the ics_auth application are returned as children of the
<RiskData>element.Syntax
<RiskData> (Factors)? (HostSeverity)? (Score)? (TimeLocal)? (ConsumerPasswordProvided)? (LostPassword)? (RepeatCustomer)? (CookiesAccepted)? (ConsumerLoyalty)? (ConsumerPromotions)? (GiftWrap)? (ReturnsAccepted)? (ProductRisk)? (AppliedThreshold)? (AppliedTimeHedge) (AppliedVelocityHedge) (AppliedHostHedge) (AppliedCategoryGift) (AppliedCategoryTime) (AppliedAVS)? (AppliedCV)? </RiskData>Table 28 Child Elements of <RiskData>
<Factors><HostSeverity><Score><TimeLocal><ConsumerPasswordProvided><LostPassword><RepeatCustomer><CookiesAccepted><ConsumerLoyalty><ConsumerPromotions><GiftWrap><ReturnsAccepted><ProductRisk><AppliedThreshold><AppliedTimeHedge><AppliedVelocityHedge><AppliedHostHedge><AppliedCategoryGift><AppliedCategoryTime><AppliedAVS><AppliedCV>
| Copyright © 2002 CyberSource Corporation. |
| |
|
|
|