Chapter 3

XML Reports

This chapter describes the format of these CyberSource XML reports:

Payment Batch Detail Report

Payment Events Report

Payment Submission Detail Report

Single Transaction Report

Transaction Exception Detail Report

User Management Report

 

See XML Report DTDs for the DTDs for XML reports.

Payment Batch Detail Report

The Payment Batch Detail Report can include these types of transactions:

•   Bank transfer and bank transfer refund

•   Credit card capture and credit

•   Direct debit and direct debit refund

•   Electronic check debit and electronic check credit

•   PayPal transactions

•   Bill Me Later transactions

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 this report with your bank statements.

For more information about reconciling transactions, see the implementation guides for the services you are using.

 

<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 8 Attributes of <Report> in the Payment Batch Detail Report

Attribute Name

Description

Data Type and Length

Name

Name of the report. This element always contains the text Payment Batch Detail.

String (100)

Version

Version number of the report. The current version number is 1.0.

Numeric (10)

xmlns

XML namespace for the report. The namespace for the current version is https://ebctest.cybersource.com/ebctest/reports/dtd/ pbdr.dtd.

String (100)

MerchantID

CyberSource merchant ID used for the transactions in the report.

String (30)

ReportStartDate

First date included in the report.

DateTime (25)

ReportEndDate

Last date included in the report.

DateTime (25)

Table 9 Child Elements of <Report> in the Payment Batch Detail Report

Element Name

Description

<Batches>

Payment batches that are included in the report. For a list of child elements, see <Batches>.

Example <Report> Element

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Report SYSTEM "https://ebctest.cybersource.com/ebctest/reports/dtd/pbdr.dtd">

<Report Name="Payment Batch Detail"

        Version="1.0"

        xmlns="https://ebctest.cybersource.com/ebctest/reports/dtd/pbdr.dtd"

        MerchantID="sample"

        ReportStartDate="2001-06-25T07:00:00-07:00"

        ReportEndDate="2001-06-26T07:00:00-07:00">

  <Batches>

    ...

  </Batches>

</Report>

<Batches>

The <Batches> element contains all of the payment batches that are included in the report.

Syntax

<Batches>
  (Batch)*
</Batches>

Table 10 Child Elements of <Batches> in the Payment Batch Detail Report

Element Name

Description

<Batch>

Requests associated with a payment batch. For a list of child elements, see <Batch>.

Example <Batches> Element

<Batches>

  <Batch BatchID="10101"

         BatchDate="2001-08-15">

    ...

  </Batch>

</Batches>

<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 11 Attributes of <Batch> in the Payment Batch Detail Report

Attribute Name

Description

Data Type and Length

BatchID

CyberSource batch in which the transaction was sent.

Numeric (39)

BatchDate

Date when the batch was sent to the processor.

Date (10)

Example <Batch> Element

<Batch BatchID="10101"

       BatchDate="2001-08-15">

  <Requests>

    ...

  </Requests>

</Batch>

<Requests>

The <Requests> element contains all of the requests from a payment batch.

Syntax

<Requests>
  (Request)*
</Requests>

Table 12 Child Elements of <Requests>

Element Name

Description

<Request>

Information about a payment transaction. For a list of child elements, see <Request>.

Example <Requests> Element

<Requests>

  <Request RequestID="0062929390000167905114"

           MerchantReferenceNumber="58EA07517FE5A71C016884DCB">

    ...

  </Request>

</Requests>

<Request>

The <Request> element contains information about a payment transaction.

Syntax

<Request RequestID=CDATA
         MerchantReferenceNumber=CDATA>
  (TransactionReferenceNumber)
  (PaymentMethod)
  (CurrencyCode)
  (Amount)
  (Application)
</Request>

Table 13 Attributes of <Request> in the Payment Batch Detail Report

Attribute Name

Description

Data Type and Length

RequestID

Unique identifier generated by CyberSource for the transaction.

Numeric (26)

MerchantReferenceNumber

Merchant-generated order reference or tracking number.

String (50)

Table 14 Child Elements of <Request> in the Payment Batch Detail Report

Element Name

Description

Data Type and Length

<TransactionReferenceNumber>

Reference number that you use to reconcile your CyberSource reports with your processor reports.

This field corresponds to the <service>_reconciliationID (Simple Order API) and to the <service>_trans_ref_no (SCMP API) reply fields.

String (60)

<PaymentMethod>

Type of card or bank account. For the possible values, see Appendix E, Types of Cards and Bank Accounts.

String (50)

<CurrencyCode>

ISO currency code used for the transaction.

String (5)

<Amount>

Amount of the transaction.

Amount (19)

<Application>

CyberSource payment application processed for the transaction.

String (50)

Example <Request> Element

<Request RequestID="0062929390000167905114"

         MerchantReferenceNumber="58EA07517FE5A71C016884DCB">

  <TransactionReferenceNumber>SJZPTM07Y8O5
  </TransactionReferenceNumber>

  <PaymentMethod>Visa</PaymentMethod>

  <CurrencyCode>USD</CurrencyCode>

  <Amount>100.00</Amount>

  <Application>ics_bill</Application>

</Request>

Payment Events Report

This report contains information about events that occur for:

•   Bank transfers

•   China payments and refunds

•   Credit card transactions processed with the CyberSource Global Payment Service

•   Direct debits

•   Electronic check debits and credits

•   PayPal transactions

Report Generation for the Global Payment Service

The report is generated daily Monday through Friday unless CyberSource does not receive a data file from the processor, receives the data file after the cut-off time, or receives an empty data file. Because the report is not generated on weekends, the report that you download on Mondays contains all your weekend transactions. Make sure your implementation can handle reports that contain transactions spanning multiple processing days.

The report is generated for the date when CyberSource processes the file, not for the date when the processor submits the file. Because of cut-off and processing times, transactions that you process on Day 1 will most likely appear on the report on Day 3.

If the generation of the report is delayed, you are notified. Because the report generated after a delay may span more than one day, make sure you can track the delayed reports.

When CyberSource needs to regenerate a report, the entire report is generated, not selected transactions. You are notified as soon as the new version of the report is available. Make sure your implementation can recognize and process only the transactions that were modified or added to the report.

Transaction Exceptions for the Global Payment Service

Although most reports contain transactions that you can match, your implementation also needs to recognize payment and refund exceptions. In some cases, you might need to search your system manually for the original request ID, which remains in the CyberSource system for six months.

•   Rejected payments and refunds

Although the reply that you receive from CyberSource might indicate that a transaction was successful, the processor can occasionally reject a transaction. Rejected transactions do not appear on the Payment Events Report. However, Customer Support will notify you by email if rejections occur.

•   Delayed payments

You need to be aware that payments can occasionally be delayed.

•   Unmatched payments and refunds

Unmatched events occur when the processor generates an event that cannot be matched or when the event is older than six months. If CyberSource cannot match the payment or refund to a specific transaction, CyberSource generates a new request ID for the unmatched event. You may need to search manually for the original request in your system.

•   Corrections to payments and refunds

When the amount of the original event is changed or the event is reversed, you need to update the original payment or refund.

Duplicate payments and refunds can appear in the same or different reports. You can ignore these events because they will match an existing request ID. You may need to search manually for the original request in your system.

<Report>

The <Report> element is the root element of the report.

Syntax

<Report Name=CDATA
        Version=NMTOKEN
        xmlns=CDATA
        MerchantID=NMTOKEN
        ReportStartDate=NMTOKEN
        ReportEndDate=NMTOKEN>
  (Requests)
</Report>

Table 15 Attributes of <Report> in the Payment Events Report

Attribute Name

Description

Data Type and Length

MerchantID

CyberSource merchant ID used for the transaction.

String (30)

Name

Name of the report. This field always contains the text Payment Events.

String (100)

ReportStartDate

First date that is included in the report.

DateTime (25)

ReportEndDate

Last date that is included in the report.

DateTime (25)

Version

Version number of the report. The current version number is 1.0.

Numeric (10)

xmlns

XML namespace for the report. The namespace for the current version is

Test: https://ebctest.cybersource.com/ebctest/reports/dtd/per.dtd

Production: https://ebc.cybersource.com/ebc/reports/dtd/per.dtd.

String (100)

Table 16 Child Elements of <Report> in the Payment Events Report

Element Name

Description

<Requests>

Contains all of the requests in the report. For a list of child elements, see <Requests>.

Example <Report> Element

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Report SYSTEM "https://ebc.cybersource.com/ebc/reports/dtd/per.dtd">

<Report Name="Payment Events"

        Version="1.0"

        xmlns="https://ebc.cybersource.com/ebc/reports/dtd/per.dtd"

        MerchantID="CyberSource"

        ReportStartDate="2002-08-16T08:00:00-07:00"

        ReportEndDate="2002-08-17T08:00:00-07:00">

  <Requests>

    ...

  </Requests>

</Report>

<Requests>

The <Requests> element contains all the requests that are included in the report.

Syntax

<Requests>
  (Request)*
</Requests>

Table 17 Child Elements of <Requests> in the Payment Events Report

Element Name

Description

<Request>

Information about a single request. For a list of child elements, see <Request>.

Example <Requests> Element

<Requests>

  <Request RequestID="0004223530000167905139"

           MerchantReferenceNumber="3C515C71D48F631">

    ...

  </Request>

</Requests>

<Request>

The <Request> element contains information about the type of payment transaction.

Syntax

<Request RequestID=CDATA
         MerchantReferenceNumber=CDATA>
  (BankTransfer) | (CreditCard) | (DirectDebit) | (Check) | (PayPal)
</Request>

Table 18 Attributes of <Request> in the Payment Events Report

Attribute Name

Description

Data Type and Length

RequestID

Unique identifier generated by CyberSource for the transaction. If your payment processor is Global Collect, the value inserted into this field can be 1 followed by 21 zeros in these cases:

• The transaction is older than six months, and the request ID is no longer stored.

• The transaction information sent by the processor, excluding a valid request ID.

Numeric (26)

MerchantReferenceNumber

Merchant-generated order reference or tracking number.

String (50)

Table 19 Child Elements of <Request> in the Payment Events Report

Element Name

Description

<BankTransfer>

Information about a bank transfer transaction, a China payment, or a China refund. For a list of child elements, see <BankTransfer>, <CreditCard>, and <DirectDebit>.

<CreditCard>

Information about a credit card transaction, a China payment, or a China refund. For a list of child elements, see <BankTransfer>, <CreditCard>, and <DirectDebit>.

<DirectDebit>

Information about a direct debit transaction. For a list of child elements, see <BankTransfer>, <CreditCard>, and <DirectDebit>.

<Check>

Information about a check transaction. For a list of child elements, see <Check>.

<PayPal>

Information about a PayPal transaction. For a list of child elements, see <PayPal>.

Example <Request> Element

<Request RequestID="0004223530000167905139">

         MerchantReferenceNumber="3C515C71D48F631">

  <BankTransfer>

    ...

  </BankTransfer>

</Request>

<BankTransfer>, <CreditCard>, and <DirectDebit>

The <BankTransfer>, <CreditCard>, and <DirectDebit> elements contain information about transactions that use these payment types. Information about China payments and China refunds is contained in the <CreditCard> element for international credit card transactions and in the <BankTransfer> element for Chinese bank card and PayEase eWallet transactions. All three elements have the same attributes and child elements. The <BankTransfer> element is used in the rest of this section to show the syntax for all three elements.

Syntax

<BankTransfer Event=CDATA
              EventDate=NMTOKEN>
  (TransactionReferenceNumber)
  (MerchantCurrencyCode)
  (MerchantAmount)
  (ConsumerCurrencyCode)
  (ConsumerAmount)
  (ProcessorMessage)?
  (Exception)?
  (BoletoNumber)?

  (PaymentTypeDescription)
</BankTransfer>

Table 20 Attributes of <BankTransfer>, <CreditCard>, and <DirectDebit> in the Payment Events Report

Attribute Name

Description

Data Type and Length

Event

Type of event that occurred for the transaction.

Bank Transfers, Credit Cards, and Direct Debits

• Chargeback: The customer did not authorize the transaction. For details about the chargeback, see <ProcessorMessage>.

• Correction: The payment or refund was corrected, or the bank was unable to credit the customer's account; the values is either positive or negative.

• Failed: The account was invalid or disabled. For details about the failure, see <ProcessorMessage>.

• Other: The processor reported an unanticipated event.

• Payment: The payment was received by the processor’s bank; the value is always positive.

• Refund: The money was returned to the customer; the value is always negative. For details about the refund, see <ProcessorMessage>.

• Reversal: A payment was reversed. For details about the reversal, see <ProcessorMessage>.

• Settled: The transaction has been settled: the payment has been received, or the refund has been given to the customer.

Alpha (20)

 

• Settled Unmatched: A bank transfer payment has been received but cannot be matched to the original request.

China Payments and China Refunds

• Chargeback: The original payment transaction is being disputed by the cardholder or the cardholder’s bank.

• Payment Abnormal: The payment has been held up for regulatory or legal reasons.

• Payment Declined: The processor has refused the payment request.

• Payment Failed: The payment request failed. The reason is not specified.

• Payment Funded: The processor has submitted a transfer to the merchant's bank account as a result of a settled payment.

• Payment Initiated: The payment request was received from the merchant.

• Payment Lost: The processor does not acknowledge receiving the payment request.

• Payment Pending Proc: The payment has not been completed. It is awaiting settlement by the processor.

• Payment Settled: The payment has been confirmed by the processor and is expected to be funded.

• Refund Abnormal: The refund has been held up for regulatory or legal reasons.

• Refund Declined: The processor has refused the refund request.

• Refund Failed: The refund request failed. The reason is not specified.

• Refund Funded: The processor has submitted a transfer to the merchant's bank account as a result of a settled refund.

• Refund Pending Cyb: The refund has not been completed. It is awaiting transmission by CyberSource.

• Refund Pending Proc: The refund has not been completed. It is awaiting settlement by the processor.

• Refund Settled: The refund has been confirmed by the processor and is expected to be funded.

• Unknown: The processor does not acknowledge receiving the request.

Boletos Bancαrios

• Fulfilled: The bank issuing the Boleto Bancαrio has received funds and has deposited them into your account.

• Pending Fulfillment: The Boleto Bancαrio was issued, but the customer has not submitted it, or it is still in the Brazilian Clearing System.

 

EventDate

Date of the event.

DateTime (25)

Table 21 Child Elements of <BankTransfer>, <CreditCard>, and <DirectDebit> in the Payment Events Report

Element Name

Description

Data Type and Length

<TransactionReferenceNumber>

Reference number that you use to reconcile your CyberSource reports with your processor reports.

This field corresponds to these reply fields: <service>_reconciliationID (Simple Order API) and <service>_trans_ref_no (SCMP API).

String (60)

<MerchantCurrencyCode>

ISO currency code of the merchant’s currency.

String (5)

<MerchantAmount>

The amount deposited or withdrawn from the merchant’s account for the event.

Amount (19)

<ConsumerCurrencyCode>

ISO currency code of the customer’s currency.

String (5)

<ConsumerAmount>

The amount deposited or withdrawn from the customer’s account for the event.

Amount (19)

<ProcessorMessage>

Additional information about the event from the processor, such as an error message or explanation.

For Global Collect direct debit reversals, this field contains a banking reversal code. For more information, see Appendix G, Banking Codes in the Payment Events Report .

String (255)

<Exception>

Additional information about an exception that occurred for the Boleto Bancαrio transaction. This field can contain one of these values:

• Overpaid: The amount paid was larger than the amount of the order.

• Underpaid: The amount paid was smaller than the amount of the order.

• Unmatched: The transaction information could not be matched to an order in the CyberSource database. If you receive this value, contact Customer Support.

String (12)

<BoletoNumber>

Boleto Bancαrio payment number.

String (6)

<PaymentTypeDescription>

Description of the payment type, such as Direct Debit.

String (50)

Example <BankTransfer> Element

<BankTransfer Event="Payment" EventDate="2003-02-16T00:00-07:00">

  <TransactionReferenceNumber>5652882910</TransactionReferenceNumber>

  <MerchantCurrencyCode>EUR</MerchantCurrencyCode>

  <MerchantAmount>100.00</MerchantAmount>

  <ConsumerCurrencyCode>EUR</ConsumerCurrencyCode>

  <ConsumerAmount>100.00</ConsumerAmount>

</BankTransfer>

<Check>

The <Check> element contains information about electronic check transactions.

Syntax

<Check Event=CDATA
       EventDate=NMTOKEN>
  (TransactionReferenceNumber)
  (MerchantCurrencyCode)
  (MerchantAmount)
  (ConsumerCurrencyCode)
  (ConsumerAmount)
  (FeeCurrencyCode)
  (FeeAmount)
  (ProcessorMessage)?

  (PaymentTypeDescription)
</Check>

Important Depending on your check processor, the impact of the type of event in the following table on the movement of funds may differ. Contact your processor to understand the implications of each event type for your payment process.

Table 22 Attributes of <Check> in the Payment Events Report

Attribute Name

Description

Data Type and Length

Event

Type of event that occurred for the check transaction. These values vary with the processor.

Successful Events

• Payment: Payment has been received. The value is always positive.

• Refund: A refund (credit) occurred. The value is always negative.

• Completed: The transaction was completed:

CyberSource ACH Service: The event type is Payment after a debit request is received by the bank. CyberSource waits for three days. If the bank does not inform CyberSource about any problems with the funds transfer, the bank considers the check cleared. The event type listed in the report is Completed when the check clears. CyberSource does not guarantee that the check has truly cleared.

String (20)

 

Bank of America ACH Service: The event type is not automatically updated to Completed. Contact Customer Support to have your account configured to display the Completed event. CyberSource does not recommend using this event type because it is not a reliable indication that a check has cleared.

Failed Events

• Correction: A positive or negative correction occurred to a payment or refund.

• Declined: The account was invalid or disabled. For details about the decline, see <ProcessorMessage>.

• Error: An error occurred. For details about the error, see <ProcessorMessage>.

• Failed: The account was invalid or disabled. For details about the failure, see <ProcessorMessage>.

• Final NSF: The final instance of insufficient funds occurred.

• First NSF: The bank will attempt to re-deposit the funds.

• NSF: The bank returned the check because of insufficient funds.

• Other: The processor reported an unanticipated event.

• Second NSF: The bank will attempt to re-deposit the funds for the second time.

• Stop Payment: The customer stopped the payment.

• Void: The check was successfully voided.

 

EventDate

Date in GMT format that the event occurred. This field can be null for some event types, such as Declined.

DateTime (25)

Table 23 Child Elements of <Check> in the Payment Events Report

Element Name

Description

Data Type and Length

<FeeCurrencyCode>

ISO currency code of the assessed fee.

String (5)

<FeeAmount>

The processor’s fee for the transaction.

Amount (19)

<ProcessorMessage>

Additional information from the processor about the event, such as an error message or explanation.

String (255)

<PaymentTypeDescription>

Description of the payment type, such as Checking.

String (50)

<Check>

Also includes the child elements described in Table 21.

 

Example <Check> Element

<Check Event="Payment" EventDate="2003-02-16T00:00-07:00">

  <TransactionReferenceNumber>5652882910</TransactionReferenceNumber>

  <MerchantCurrencyCode>USD</MerchantCurrencyCode>

  <MerchantAmount>100.00</MerchantAmount>

  <ConsumerCurrencyCode>USD</ConsumerCurrencyCode>

  <ConsumerAmount>100.00</ConsumerAmount>

  <FeeCurrencyCode>USD</FeeCurrencyCode>

  <FeeAmount>1.00</FeeAmount>

</Check>

<PayPal>

The <PayPal> element contains information about transactions that use this payment type.

Syntax

<PayPal Event=CDATA
        EventDate=NMTOKEN>
  (TransactionReferenceNumber)
  (MerchantCurrencyCode)?
  (MerchantAmount)
  (ConsumerCurrencyCode)
  (ConsumerAmount)
  (FeeCurrencyCode)
  (FeeAmount)
  (ProcessorMessage)?

  (PaymentTypeDescription)
</PayPal>

Table 24 Attributes of <PayPal> in the Payment Events Report

Attribute Name

Description

Data Type and Length

Event

Type of event that occurred for the PayPal transaction. This field contains one of these values:

• Batched: The PayPal transaction was completed, but the funds have not been transferred to your account.

• Canceled_reversal: You requested that the reversal requested by the customer be cancelled.

• Completed: The PayPal transaction was completed, and the funds have been transferred to your account.

• Denied: You denied the request. The reason is not specified.

• Failed: The request failed. The reason is not specified.

• MIPS: A billing agreement was created or modified.

Alpha (20)

 

• Pending: The PayPal transaction is not completed. The value will eventually change to Completed, Failed, or Denied.

• Refunded: You initiated a refund of the PayPal payment.

• Reversed: A payment was reversed due to a chargeback or other type of reversal.

 

EventDate

Date of the event. This field is null for some event types, such as Declined. For PayPal transactions, the date is always present.

DateTime (25)

Table 25 Child Elements of <PayPal> in the Payment Events Report

Element Name

Description

Data Type and Length

<TransactionReferenceNumber>

Reference number that you use to reconcile your CyberSource reports with your processor reports. This field corresponds to the <service>_reconciliationID (Simple Order API) and to the <service>_trans_ref_no (SCMP API) reply fields.

String (60)

<MerchantCurrencyCode>

ISO currency code of the merchant’s currency. Reported only if MerchantAmount is greater than zero.

String (5)

<MerchantAmount>

The amount deposited or withdrawn from the merchant’s account for the event. Reported only if the Paypal account is set to automatically convert payment.

Amount (19)

<ConsumerCurrencyCode>

ISO currency code of the customer’s currency.

String (5)

<ConsumerAmount>

The amount deposited or withdrawn from the customer’s account for the event.

Amount (19)

<FeeCurrencyCode>

This element does not apply to PayPal Payments and is always empty.

NA

<FeeAmount>

The processor’s fee for the transaction.

Amount (19)

<ProcessorMessage>

Additional information that may appear about the event from the processor, such as an error message or reason. This field contains one of these values:

• pending: The payment status is pending.

• For a credit or a reversal, this field contains one of these values:

• address: The customer did not include a confirmed shipping address. You must manually accept or deny this payment.

String (255)

 

• buyer_complaint: The customer has placed a reversal about this transaction.

• chargeback: The customer has initiated a chargeback.

• echeck: The check has not yet cleared.

• guarantee: The customer triggered a money back guarantee.

• intl: You hold a non-U.S. account and do not have a withdrawal method. You must manually accept or deny this payment.

• multi_currency: You do not have a balance in the currency sent. You must manually accept or deny this payment.

• other: A reversal has occurred for a reason other than buyer_complaint, chargeback, guarantee, or refund. Alternately, the payment is pending for a reason other than address, echeck, intl, multi_currency, unilateral, upgrade, or verify.

• refund: You have given the customer a refund.

• unilateral: The payment was made to an email address that is not yet registered or confirmed.

• upgrade: You have reached the monthly limit for transactions on your account, or the payment was made via credit card, and you do not have a Business or Premier PayPal account.

• verify: The payment is pending. You must verify your account before accepting this payment.

 

<PaymentTypeDescription>

Description of the payment type, such as PayPal.

String (50)

Example <PayPal> Element

<PayPal Event="Completed" EventDate="2003-02-16T00:00-07:00">

  <TransactionReferenceNumber>5652304882910</TransactionReferenceNumber>

  <MerchantAmount>0.00</MerchantAmount>

  <ConsumerAmount>100.00</ConsumerAmount>

  <FeeCurrencyCode/>

  <FeeAmount>1.00</FeeAmount>

</PayPal>

Payment Submission Detail Report

The XML version of the Payment Submission Detail Report is identical to the XML version of the Payment Batch Detail Report with these exceptions:

•   The Payment Submission Detail Report includes these types of transactions:

• China payments and China refunds

• Boletos Bancαrios

•   The Payment Submission Detail Report includes these elements, which are child elements of the <Request> element:

• <PaymentProcessor>

• <DCCIndicator>

• <BoletoNumber>

• <NumberOfInstallments>

<Request>

The <Request> element in the Payment Submission Detail Report has several additional fields that are not included in the <Request> element in the Payment Batch Detail Report. The <Request> element contains information about a payment transaction.

Syntax

<Request RequestID=CDATA
         MerchantReferenceNumber=CDATA>
  (TransactionReferenceNumber)
  (PaymentMethod)
  (CurrencyCode)
  (Amount)
  (Application)
  (PaymentProcessor)
  (TargetAmount?)
  (TargetCurrency?)
  (ExchangeRate?)
  (ExchangeRateDate?)
  (DCCIndicator?)
  (BoletoNumber?)
  (NumberOfInstallments?)
</Request>

Table 26 Additional Child Elements of <Request> in the Payment Submission Detail Report

Element Name

Description

Data Type and Length

The first five child elements are the same as the child elements in the <Request> element in the Payment Batch Detail Report. See <Request>.

<PaymentMethod>

Type of card or bank account. Values found only in the Payment Submission Detail Report:

• Brazil Bank Transfer

• China Bank Transfer

• China eWallet

For the values that can be in the Payment Batch Detail Report and the Payment Submission Detail Report, see <Request>.

String (50)

<PaymentProcessor>

For the list of payment processors, see Appendix D, Payment Processors.

String (40)

<TargetAmount>

Converted amount.

String (15)

<TargetCurrency>

Billing currency. This is the ISO code for the currency of the converted amount. See the Support Center for a list of ISO codes.

String (5)

<ExchangeRate>

Exchange rate. Includes a decimal point and up to 4 decimal places.

Amount (13)

<ExchangeRateDate>

Time stamp for the exchange rate in the format YYYYMMDD~HH:MM where ~ denotes a space.

String (14)

<DCCIndicator>

Flag that indicates if DCC is being used for the transaction. This field can contain one of these values:

• 1: Converted—DCC is being used.

• 2: Non-convertible—DCC cannot be used.

• 3: Declined—DCC could be used, but the customer declined it.

String (1)

<BoletoNumber>

Boleto Bancαrio payment number.

String (6)

<NumberOfInstallments>

Total number of installments when making payments in installments. For more information, see the Credit Card Services Implementation Guide.

Numeric (2)

Example <Request> Element

<Request RequestID="0062929390000167905114"

         MerchantReferenceNumber="58EA07517FE5A71C016884DCB">

  <TransactionReferenceNumber>SJZPTM07Y8O5
  </TransactionReferenceNumber>

  <PaymentMethod>Visa</PaymentMethod>

  <CurrencyCode>USD</CurrencyCode>

  <Amount>100.00</Amount>

  <Application>ics_bill</Application>

  <PaymentProcessor>fdcsouth</PaymentProcessor>

  <TargetAmount>120.00</TargetAmount>

  <TargetCurrency>EUR</TargetCurrency>

  <ExchangeRate>1.2</ExchangeRate>

  <ExchangeRateDate>20071001 16:00</ExchangeRateDate>

  <DCCIndicator>1</DCCIndicator>

</Request>

Single Transaction Report

This report contains this information about a single request ID:

•   Summary information about your payment transactions: credit card, electronic check, Bill Me Later, China processing, Boletos Bancαrios, and bank transfers.

•   ACH Verification results

•   Detailed information about Decision Manager and the score or Advanced Fraud Screen service.

<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 27 Attributes of <Report> in the Single Transaction Report

Attribute Name

Description

Data Type and Length

MerchantID

CyberSource merchant ID used for the transaction.

String (30)

Name

Name of the report. This field always contains the text Transaction Detail.

String (100)

ReportStartDate

First date that is included in the report.

DateTime (25)

ReportEndDate

Last date that is included in the report.

DateTime (25)

Version

Version number of the report from 1.0 to 1.7.

Numeric (10)

xmlns

XML namespace for the report version that you requested:

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_7.dtd

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_6.dtd

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_5.dtd

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_4.dtd

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_3.dtd

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_2.dtd

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_1.dtd

• https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_0.dtd

String (100)

Table 28 Child Elements of <Report> in the Single Transaction Report

Element Name

Description

<Requests>

Contains all the requests in the report. For a list of child elements, see <Requests>.

Example <Report> Element

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Report SYSTEM "https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_1.dtd">

<Report MerchantID="CyberSource"

        Name="Transaction Detail"

        ReportStartDate="2001-08-16T08:00:00-08:00"

        ReportEndDate="2001-08-17T08:00:00-08:00"

        Version="1.1"

        xmlns="https://ebctest.cybersource.com/ebctest/reports/dtd/tdr_1_1.dtd">

  <Requests>

    ...

  </Requests>

</Report>

<Requests>

The <Requests> element contains all of the requests in the report.

Syntax

<Requests>
  (Request)*
</Requests>

Table 29 Child Elements of <Requests> in the Single Transaction Report

Element Name

Description

<Request>

Information about a single request. For a list of child elements and attributes, see <Request>.

Example <Requests> Element

<Requests>

  <Request MerchantReferenceNumber="3C515C71D48F631"

           RequestDate="2009-08-16T09:42:03-08:00"

           RequestID="0004223530000167905139">

    ...

  </Request>

</Requests>

<Request>

The <Request> element contains information about a single request. A request can include multiple CyberSource applications. The TransactionReferenceNumber attribute is available only in versions 1.2 and greater. The User and PredecessorRequestID attributes are available only in versions 1.3 and greater. The <TravelData> element is available only in versions 1.6 and greater.

Syntax

<Request MerchantReferenceNumber=CDATA
         RequestDate=CDATA
         RequestID=CDATA
         SubscriptionID=CDATA
         Source=CDATA
         User=CDATA
         Comments=CDATA
         TransactionReferenceNumber=CDATA
         PredecessorRequestID=CDATA
  (BillTo)
  (ShipTo)?
  (Shipping)?
  (PaymentMethod)
  (LineItems)?
  (ApplicationReplies)
  (PaymentData)?
  (MerchantDefinedData)?
  (RiskData)?
  (ProfileList)?

  (TravelData)?>
</Request>

Table 30 Attributes of <Request> in the Single Transaction Report

Attribute Name

Description

Data Type and Length

MerchantReferenceNumber

Merchant-generated order reference or tracking number.

String (50)

RequestDate

Date on which the transaction was processed.

DateTime (25)

RequestID

Unique identifier generated by CyberSource for the transaction.

Numeric (26)

SubscriptionID

Unique identifier that is returned to you when a subscription is created.

String (26)

Source

Client application used to send the transaction. This field can contain one of these values:

• HOP

• PIN-less Debit Validation

• SCMP API

String (50)

 

• SOP

• Subscription Add

• UBC

• UBC List Manager

• UBC One Time Payment

• UBC Subscription

• UBC Subscription Edit

• UBC Virtual Terminal

 

User

User name in the Business Center of the person who performed the transaction.

Note  This element is included only in versions 1.3 and greater.

String (36)

Comments

If present, brief description of the order or comment that was added to the order.

String (255)

TransactionReference
Number

CyberSource-generated reference or tracking number for the transaction. You can use this value to reconcile your CyberSource reports with your processor reports.

Note  This element is included only in versions 1.2 and greater.

String (60)

PredecessorRequestID

Unique identifier generated by CyberSource for the transaction against which the current request was applied.

Note  This element is included only in versions 1.3 and greater.

Numeric (26)

Table 31 Child Elements of <Request> in the Single Transaction Report

Element Name

Description

<BillTo>

Information about the billing address and purchaser for the order. For a list of child elements, see <BillTo>.

<ShipTo>

Information about the shipping address and recipient for the order. For a list of child elements, see <ShipTo>.

<Shipping>

Information about the shipping method and shipping carrier for the order. For a list of child elements, see <Shipping>.

<PaymentMethod>

Information about the payment method for the order. For a list of child elements, see <PaymentMethod>.

<LineItems>

Line items for the order. For a list of child elements, see <LineItems>.

<ApplicationReplies>

Reply information for all applications in the request. For a list of child elements, see <ApplicationReplies>.

<PaymentData>

Detailed information about the result of a payment transaction. For a list of child elements, see <PaymentData>.

<MerchantDefinedData>

Optional information that you added to the order. For a list of child elements, see <MerchantDefinedData>.

<RiskData>

Detailed information about the result of a risk transaction. For a list of child elements, see <RiskData>.

<ProfileList>

Information about the profile used for the order. For a list of child elements, see <ProfileList>.

<TravelData>

Detailed information about the travel data in the order. For a list of child elements, see <TravelData>.

Example <Request> Element

<Request MerchantReferenceNumber="3C515C71D48F631"

         RequestDate="2009-08-16T09:42:03-08:00"

         RequestID="0004223530000167905139"

         SubscriptionID=""

         Source=SCMP API

         User=""

         Comments=""

         TransactionReferenceNumber=""

         PredecessorRequestID="">

  <BillTo>...</BillTo>

  <ShipTo>...</ShipTo>

  <Shipping>...</Shipping>

  <PaymentMethod>...</PaymentMethod>

  <LineItems>...</LineItems>

  <ApplicationReplies>...</ApplicationReplies>

  <PaymentData>...</PaymentData>

  <MerchantDefinedData>...</MerchantDefinedData>

  <RiskData>...</RiskData>

  <ProfileList>...</ProfileList>

  <TravelData>...</TravelData>

</Request>

<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)?
  (CustomerID)?
</BillTo>

Table 32 Child Elements of <BillTo> in the Single Transaction Report

Element Name

Description

Data Type and Length

<FirstName>

First name of the billed customer.

String (60)

<LastName>

Last name of the billed customer.

String (60)

<MiddleName>

Middle name of the billed customer.

String (60)

<NameSuffix>

Suffix of the billed customer’s name.

String (60)

<Address1>

First line of the billing address.

String (60)

<Address2>

Second line of the billing address.

String (60)

<City>

City of the billing address.

String (50)

<State>

State, province, or territory of the billing address.

String (20)

<Zip>

Postal code of the billing address.

String (10)

<CompanyName>

Company name of the billing address.

String (60)

<Email>

Email address of the bill-to customer.

String (255)

<Country>

ISO country code of the billing address.

String (2)

<Title>

Title of the billed customer.

String (30)

<Phone>

Phone number of the billed customer.

String (15)

<IPAddress>

IP address of the billed customer.

String (15)

<HostName>

DNS-resolved host name from the customer’s IP address.

String (255)

<UserName>

Reserved for future use.

String (50)

<CustomerID>

Optional customer’s account ID, tracking number, reward number or other unique number.

String (50)

Example <BillTo> Element

<BillTo>

  <FirstName>John</FirstName>

  <LastName>Doe</LastName>

  <Address1>1295 Charleston Rd.</Address1>

  <City>Mountain View</City>

  <State>CA</State>

  <Zip>94043</Zip>

  <Email>icsinfo@cybersource.com</Email>

  <Country>US</Country>

  <Phone>650-965-6000</Phone>

  <IPAddress>127.0.0.1</IPAddress>

  <CustomerID>jdoe94043</CustomerID>

</BillTo>

<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 33 Child Elements of <ShipTo> in the Single Transaction Report

Element Name

Description

Data Type and Length

<FirstName>

First name of the customer to whom the order is shipped.

String (60)

<LastName>

Last name of the customer to whom the order is shipped.

String (60)

<Address1>

First line of the shipping address.

String (60)

<Address2>

Second line of the shipping address.

String (60)

<City>

City of the shipping address.

String (60)

<State>

State, province, or territory of the shipping address.

String (50)

<Zip>

Postal code of the shipping address.

String (10)

<CompanyName>

Company name of the shipping address.

String (60)

<Country>

ISO country code of the shipping address.

String (2)

<Phone>

Phone number of the customer to whom the order is shipped.

String (15)

Example <ShipTo> Element

<ShipTo>

  <Address1>1295 Charleston Rd.</Address1>

  <City>Mountain View</City>

  <State>CA</State>

  <Zip>94043</Zip>

  <Country>US</Country>

</ShipTo>

<Shipping>

The <Shipping> element contains information about the shipping method and shipping carrier for the order.

Syntax

<Shipping>
  (Method)
  (Carrier)
</Shipping>

Table 34 Child Elements of <Shipping> in the Single Transaction Report

Element Name

Description

Data Type and Length

<Method>

Reserved for future use.

String (10)

<Carrier>

Reserved for future use.

String (12)

Example <Shipping> Element

<Shipping>

  <Method />

  <Carrier />

</Shipping>

<PaymentMethod>

The <PaymentMethod> element contains information about the payment method for the order.

If a credit card or China payment 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 35 Child Elements of <PaymentMethod> in the Single Transaction Report

Element Name

Description

<Card>

Information used to process a credit card or China payment. For a list of child elements, see <Card>.

<Check>

Information used to process an electronic check. For a list of child elements, see <Check>.

Example <PaymentMethod> Element

<PaymentMethod>

  <Card>

    ...

  </Card>

</PaymentMethod>

<Card>

The <Card> element contains information used to process a credit card, China payment, or Boleto Bancαrio. For requests that do not include payment information, all child elements of <Card> will be empty. The <BoletoNumber> element is available only in versions 1.4 and greater.

Syntax

<Card>
  (AccountSuffix)
  (ExpirationMonth)
  (ExpirationYear)
  (StartMonth)?
  (StartYear)?
  (IssueNumber)?
  (CardType)?
  (BoletoNumber)?
</Card>

Table 36 Child Elements of <Card> in the Single Transaction Report

Element Name

Description

Data Type and Length

<AccountSuffix>

Last four digits of the customer’s credit card number.

String (4)

<ExpirationMonth>

Expiration month (MM) of the credit card.

String (2)

<ExpirationYear>

Expiration year (YYYY) of the credit card.

String (4)

<StartMonth>

Start month (MM) of the credit card. Used for Maestro (UK Domestic) cards.

String (2)

<StartYear>

Start year (YYYY) of the credit card. Used for Maestro (UK Domestic) cards.

String (4)

<IssueNumber>

Issue number of the credit card. Used for Maestro (UK Domestic) cards.

String (5)

<CardType>

Type of card or bank account. For the possible values, see Appendix E, Types of Cards and Bank Accounts.

String (50)

BoletoNumber

Boleto Bancαrio payment number.

Note  This value is included only for versions 1.4 and greater.

String (6)

Example <Card> Element

<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 37 Child Elements of <Check> in the Single Transaction Report

Element Name

Description

Data Type and Length

<AccountSuffix>

Last four digits of the customer’s bank account number.

String (4)

<CheckNumber>

Reserved for future use.

String (10)

Example <Check> Element

<Check>

  <AccountSuffix>1111</AccountSuffix>

</Check>

<LineItems>

The <LineItems> element contains all of the line items for the order.

Note In the SCMP API, line items are referred to as offers.

Syntax

<LineItems>
  (LineItem)*
</LineItems>

Table 38 Child Elements of <LineItems> in the Single Transaction Report

Element Name

Description

<LineItem>

Information about a single line item in an order. For a list of child elements and attributes, see <LineItem>.

Example <LineItems> Element

<LineItems>

  <LineItem Number="0">

    ...

  </LineItem>

  <LineItem Number="1">

    ...

  </LineItem>

</LineItems>

. This example includes two separate line items.

<LineItem>

The <LineItem> element contains information about a single line item in an order. In the SCMP API, line items are referred to as offers.

Syntax

<LineItem Number=CDATA>
  (FulfillmentType)
  (Quantity)?
  (UnitPrice)
  (TaxAmount)?
  (MerchantProductSKU)?
  (ProductName)?
  (ProductCode)?
</LineItem>

Table 39 Attributes of <LineItem> in the Single Transaction Report

Attribute Name

Description

Data Type and Length

Number

Number of the line item. For the first line item, the value of this attribute is 0.

Numeric (10)

Table 40 Child Elements of <LineItem> in the Single Transaction Report

Element Name

Description

Data Type and Length

<FulfillmentType>

Information about the product code used for the line item. Possible values:

• E: The product code is electronic_software.

• P: The product code is not electronic_software.

String (2)

<Quantity>

Quantity of the product being purchased.

Numeric (10)

<UnitPrice>

Per-item price of the product.

Amount (19)

<TaxAmount>

Tax amount associated with this item.

Amount (19)

<MerchantProductSKU>

Product identifier code.

String (30)

<ProductName>

Name of the product.

String (20)

<ProductCode>

Type of product that the offer contains. For detailed information about this field, see the Credit Card Services Implementation Guide. For a list of product codes used by the tax service, see the Product Code User Guide.

String (30)

Example <LineItem> Element

<LineItem Number="0">

  <FulfillmentType>P</FulfillmentType>

  <Quantity>1</Quantity>

  <UnitPrice>20.00</UnitPrice>

</LineItem>

<ApplicationReplies>

The <ApplicationReplies> element contains reply information for all applications in the request.

Syntax

<ApplicationReplies>
  (ApplicationReply)+
</ApplicationReplies>

Table 41 Child Elements of <ApplicationReplies> in the Single Transaction Report

Element Name

Description

<ApplicationReply>

Reply information for a single CyberSource application. For a list of child elements and attributes, see <ApplicationReply>.

Example <ApplicationReplies> Element. This 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 42 Attributes of <ApplicationReply> in the Single Transaction Report

Attribute Name

Description

Data Type and Length

Name

Name of the CyberSource application whose reply is described in this element.

String (30)

Table 43 Child Elements of <ApplicationReply> in the Single Transaction Report

Element Name

Description

Data Type and Length

<RCode>

One-digit code that indicates whether the application was successful.

Numeric (1)

<RFlag>

One-word description of the result of the application.

String (50)

<RMsg>

Message that explains the reply flag for the application.

String (255)

Example <ApplicationReply> Element of a successful reply

<ApplicationReply Name="ics_score">

  <RCode>1</RCode>

  <RFlag>SOK</RFlag>

  <RMsg>score service was successful</RMsg>

</ApplicationReply>

Example <ApplicationReply> Element. This example shows the reply for an application that was not run because another application in the request failed.

<ApplicationReply Name="ics_auth">

  <RCode />

  <RFlag />

  <RMsg />

</ApplicationReply>

<PaymentData>

The <PaymentData> element contains detailed information about the result of a payment transaction. The <EventType> element is available only in versions 1.2 and greater. The <NumberOfInstallments> value is available only in versions 1.4 and greater. The <ACHVerificationResult> and <ACHVerificationResultMapped> elements are available only in versions 1.5 and greater. The <GrandTotal> element is available in version 1.6 and greater. The <BalanceAmount>, <BalanceCurrencyCode>, <RequestedAmount>, and <RequestedAmountCurrencyCode> elements are available only in version 1.7 and greater.

Syntax

<PaymentData>
  (PaymentRequestID)
  (PaymentProcessor)
  (Amount)
  (CurrencyCode)
  (TotalTaxAmount)?
  (AuthorizationType)?
  (AuthorizationCode)?
  (AVSResult)?
  (AVSResultMapped)?
  (CVResult)?
  (ProcessorResponseCode)?
  (PayerAuthenticationInfo)?
  (EventType)?
  (NumberOfInstallments?)

  (ACHVerificationResult)?

  (ACHVerificationResultMapped?)

  (GrandTotal)?

  (BalanceAmount)?

  (BalanceCurrencyCode)?

  (RequestedAmount)?

  (RequestedAmountCurrencyCode)?
</PaymentData>

Table 44 Child Elements of <PaymentData> in the Single Transaction Report

Element Name

Description

Data Type and Length

<PaymentRequestID>

Original request ID for the purchase.

• For authorizations and stand-alone credits, this element contains the request ID for the transaction.

• For captures, this element contains the request ID for the corresponding authorization.

Numeric (26)

<PaymentProcessor>

See Appendix D, Payment Processors.

String (40)

<Amount>

Total amount of the authorization, capture, debit, or credit if CyberSource processed the payment request. For requests that do not contain payment information, such as when Decision Manager is requested alone, you may see an amount in the <GrandTotal> element instead.

Amount (19)

<CurrencyCode>

Currency used for the transaction.

String (5)

<TotalTaxAmount>

Total tax amount for all of the line items in the transaction.

Amount (19)

<AuthorizationType>

Type of authorization. Possible values:

• O: Online authorization. Successful authorization that was captured normally or was not captured at all.

• V: Verbal authorization. Authorization captured with a verbal authorization code.

If the authorization was not successful, or if the processor did not return an authorization code, this element is empty.

String (1)

<AuthorizationCode>

Authorization code.

String (15)

<AVSResult>

Address verification result code returned directly from the processor.

String (10)

<AVSResultMapped>

CyberSource standardized result of address verification. For a list of possible values, see the Credit Card Services Implementation Guide.

String (5)

<CVResult>

Results of processing the card verification number. For a list of possible values, see the Credit Card Services Implementation Guide.

String (1)

<ProcessorResponseCode>

Response code returned directly from the processor.

String (60)

<PayerAuthenticationInfo>

Results of the Payer Authentication service. For a list of child elements, see <PayerAuthenticationInfo>.

 

<EventType>

Type of event that occurred for the transaction. This element is included in versions 1.2 and greater.

China Payments and China Refunds

• Chargeback: The original payment transaction is being disputed by the cardholder or the cardholder’s bank.

• Payment Abnormal: The payment has been held up for regulatory or legal reasons.

• Payment Declined: The processor has refused the payment request.

• Payment Failed: The payment request failed. The reason is not specified.

• Payment Funded: The processor has submitted a transfer to the merchant's bank account as a result of a settled payment.

• Payment Initiated: The payment request was received from the merchant.

• Payment Lost: The processor does not acknowledge receiving the payment request.

• Payment Pending Proc: The payment has not been completed. It is awaiting settlement by the processor.

• Payment Settled: The payment has been confirmed by the processor and is expected to be funded.

• Refund Abnormal: The refund has been held up for regulatory or legal reasons.

• Refund Declined: The processor has refused the refund request.

• Refund Failed: The refund request failed. The reason is not specified.

• Refund Funded: The processor has submitted a transfer to the merchant's bank account as a result of a settled refund.

• Refund Pending Cyb: The refund has not been completed. It is awaiting transmission by CyberSource.

• Refund Pending Proc: The refund has not been completed. It is awaiting settlement by the processor.

• Refund Settled: The refund has been confirmed by the processor and is expected to be funded.

• Unknown: The processor does not acknowledge receiving the request.

String (20)

 

Successful Events for Electronic Check Transactions

These values vary with the processor.

• Payment: Payment has been received. The value is always positive.

• Refund: A refund (credit) occurred. The value is always negative.

• Completed: The transaction was completed:

• CyberSource ACH Service—The event type is Payment after a debit request is received by the bank. CyberSource waits for three days. If the bank does not inform CyberSource about any problems with the funds transfer, the bank considers the check cleared. The event type listed in the report is Completed when the check clears. CyberSource does not guarantee that the check has truly cleared.

Boletos Bancαrios

• Fulfilled: The bank issuing the Boleto Bancαrio has received funds and has deposited them into your account.

• Pending Fulfillment: The Boleto Bancαrio was issued but the customer has not submitted it yet or it is still in the Brazilian Clearing System.

Failed Events for Electronic Check Transactions

These values vary with the processor.

• Correction: A positive or negative correction occurred to a payment or refund.

• Declined: The account was invalid or disabled.

• Error: An error occurred.

• Failed: The account was invalid or disabled.

• Final NSF: The final instance of insufficient funds occurred.

• First NSF: The bank will attempt to re-deposit the funds.

• NSF: The bank returned the check because of insufficient funds.

• Other: The processor reported an unanticipated event.

• Second NSF: The bank will attempt to re-deposit the funds for the second time.

• Stop Payment: The customer stopped the payment.

• Void: The check was successfully voided.

 

 

Other Types of Transactions

• BATCH_ERROR: The batch file was rejected by the processor because of transaction errors. After the file is reset, the invalid transactions will be marked as TRXN ERROR.

• BATCH_RESET: Either the complete batch or specific transactions were reset after the problems with the merchant, connections, or processor were resolved.

• CANCELLED: The transaction was cancelled.

• CANCELED_REVERS: The reversal was cancelled.

• ERROR: An error occurred in your follow-on request.

• FAILED: The credit card (authorization, capture, or credit) or check debit request failed. The reason is not specified.

• FUNDED: The direct debit reversal is complete.

• MIPS: The PayPal billing agreement was created or modified.

• PAYMENT: The payment has been received.

• PENDING: The authorization was captured by CyberSource, the credit request was successful, or the credit card transaction was captured, and the request was sent to the payment processor. The reply from the payment processor is pending.

• REFUNDED: You initiated a refund of the payment.

• REVERSAL: The direct debit was reversed at the request of the customer.

• REVERSAL FAILED: The PIN-less debit reversal request failed.

• REVERSED: The PIN-less debit reversal request was successful.

• REVERSING: The initial PIN-less debit request timed out. The subsequent reversal request is pending.

• TRANSMITTED: The check debit request was processed successfully.

• VOIDED: The request for the credit card capture, credit card credit, check debit, or check credit was successfully deleted. The authorization has not been deleted. You can see this transaction only on the search results page and in the exported search results.

 

<NumberOfInstallments>

Total number of installments. For more information, see the Credit Card Services Implementation Guide. This element is included only for versions 1.4 and greater.

Numeric(2)

<ACHVerificationResult>

Raw result of the ACH Verification service. This element can contain one of these values:

• 1: Accepted: Routing number is valid. Account number is valid.

• 2: Accepted: Routing number is valid. Account number is invalid; use corrected account number.

• 3: Accepted: Routing number is valid. Account number is valid.

• 4: Accepted: Routing number is valid. Account number structure not recognized; account may be valid.

• 5: Accepted: Routing number is not usable for ACH; use corrected routing number. Account number is valid.

• 6: Accepted: Routing number is not usable for ACH; use corrected routing number. Account number is invalid; use corrected account number.

• 7: Accepted: Routing number is not usable for ACH; use corrected routing number. Account number is valid.

• 8: Accepted: Routing number is not usable for ACH; use corrected routing number. Account number structure not recognized; account may be valid.

• 9: Declined: Routing number is not usable for ACH; no corrected routing number available.

• 10: Declined: Routing number not found.

• 11: Declined: Invalid routing number.

String (2)

<ACHVerificationResult
Mapped>

Mapped result of the ACH Verification service. This element can contain one of these values:

• 00: Success: Routing and account numbers are OK.

• 01: Success: Routing number is OK; account number is corrected.

• 02: Success: Routing number is corrected; account number is OK.

• 03: Success: Routing and account numbers are corrected.

• 04: Declined: Routing number does not pass verification.

• 98: Unavailable: Unable to perform ACH verification.

• 99: Invalid: Response from ACH verification is invalid.

String (2)

<GrandTotal>

Grand total amount for the order, including tax, for requests that do not contain payment information, such as when Decision Manager is requested alone. This element contains the value of the purchaseTotals_grandTotalAmount (Simple Order API) or grand_total_amount field. If this field is absent, the grand total is calculated from the total of the line item amounts.

Amount (19)

<BalanceAmount>

Remaining balance on the prepaid card.

Amount (19)

<BalanceCurrencyCode>

Currency of the remaining balance on the prepaid card.

String (5)

<RequestedAmount>

Amount you requested to be authorized.

Amount (19)

 

<RequestedAmountCurrencyCode>

Currency for the amount requested to be authorized. This value is returned for partial authorizations.

String (5)

Example <PaymentData> Element

<PaymentData>

  <PaymentRequestID>9935369793074590426287</PaymentRequestID>

  <PaymentProcessor>sample</PaymentProcessor>

  <Amount>20.00</Amount>

  <CurrencyCode>USD</CurrencyCode>

  <AuthorizationType>O</AuthorizationType>

  <AuthorizationCode>123456</AuthorizationCode>

  <AVSResult>YYY</AVSResult>

  <AVSResultMapped>Y</AVSResultMapped>

  <CVResult>M</CVResult>

  <ProcessorResponseCode>A</ProcessorResponseCode>

  <PayerAuthenticationInfo></PayerAuthenticationInfo>

  <EventType></EventType>

  <NumberOfInstallments></NumberOfInstallments>

  <ACHVerificationResult></ACHVerificationResult>

  <ACHVerificationResultMapped><ACHVerificationResultMapped>

  <GrandTotal>20.00</GrandTotal>

</PaymentData>

<PayerAuthenticationInfo>

The <PayerAuthenticationInfo> element contains optional information about the Payer Authentication service. For detailed information about the possible values and their usage, see the Payer Authentication Developer’s Guide.

Syntax

<PayerAuthenticationInfo>
  (ECI)?
  (AAV_CAVV)?
  (XID)?

</PayerAuthenticationInfo>

Table 45 Child Elements of <PayerAuthenticationInfo> in the Single Transaction Report

Element Name

Description

Data Type and Length

<ECI>

Optional information that you can receive if you use the Payer Authentication service.

String (64)

<AAV_CAVV>

Optional authentication data that you can receive after the customer is authenticated.

String (32) (in base 64)

<XID>

Optional transaction identifier generated by Payer Authentication that you can receive when the customer is enrolled and when validation is successful.

String (28) (in base 64)

Example <PayerAuthenticationInfo> element for a MasterCard card.

<PayerAuthenticationInfo>

  <ECI>2</ECI>

  <AAV_CAVV>jLw9xEMqcxPMABEAAADH1UGO/7k=<A/AV_CAVV>

  <XID>7DDCrsDjEdqNhsAcOxvljwAHBwE=</XID>

</PayerAuthenticationInfo>

<MerchantDefinedData>

The <MerchantDefinedData> element contains optional information that you add to the order, such as an order number, additional customer information, or a special comment or request from the customer.

Syntax

<MerchantDefinedData Name=CDATA>
  (field1)?
  .
  .
  (field20)?
</MerchantDefinedData>

Table 46 Attribute of <MerchantDefinedData> in the Single Transaction Report

Attribute Name

Description

Data Type and Length

Name

Optional name of the custom field. The name appears only if the field was given a name in the Business Center before being added to the request. No name appears if the field was added to the API request.

String (30)

Table 47 Child Elements of <MerchantDefinedData> in the Single Transaction Report

Element Name

Description

Data Type and Length

<field1> through <field20>

Optional information that was added to the order, such as an order number, additional customer information, or a special comment or request from the customer.

String (255)

Example <MerchantDefinedData> element

<MerchantDefinedData>

  <field1>order number=1234</field1>

  <field4 name=shipping>see shipping address</field4>

</MerchantDefinedData>

<RiskData>

The <RiskData> element contains detailed information about the result of a risk transaction. If you use Smart Authorization, some reply fields for the card authorization service 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)?

  (BinAccountType)?

  (BinScheme)?

  (BinIssuer)?

  (BinCountry)?

  (IPCity)?

  (IPCountry)?

  (IPRoutingMethod)?

  (IPState)?

  (InfoCodes)?
</RiskData>

Table 48 Child Elements of <RiskData> in the Single Transaction Report

Element Name

Description

Data Type and Length

<Factors>

Comma-separated list of codes that indicate what factors affected the score of the order. For a list of factor codes, see the Decision Manager Developer’s Guide.

Note If you use Smart Authorization, the value of the reply field auth_factor_code is returned in this field.

String (100)

<HostSeverity>

Indicates the risk associated with the customer’s email domain.

Numeric (5)

<Score>

Total score calculated for the order.

Numeric (5)

<TimeLocal>

The customer’s local time, which is calculated from the transaction request time and the customer’s billing address.

DateTime (25)

<ConsumerPasswordProvided>

Reserved for future use.

Boolean (1)

<LostPassword>

Reserved for future use.

Boolean (1)

<RepeatCustomer>

Reserved for future use.

Boolean (1)

<CookiesAccepted>

Reserved for future use.

Boolean (1)

<ConsumerLoyalty>

Reserved for future use.

Boolean (1)

<ConsumerPromotions>

Reserved for future use.

Boolean (1)

<GiftWrap>

Reserved for future use.

Boolean (1)

<ReturnsAccepted>

Reserved for future use.

Boolean (1)

<ProductRisk>

Reserved for future use.

String (6)

<AppliedThreshold>

Score threshold applied to the order. For information about how ics_score selects a threshold, see the Decision Manager Developer’s Guide.

Numeric (5)

<AppliedTimeHedge>

Importance of time of day in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.

String (6)

<AppliedVelocityHedge>

Importance of the number of orders from the customer in a specific time period in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.

String (6)

<AppliedHostHedge>

Importance of email and IP addresses of the customer in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.

String (6)

<AppliedCategoryGift>

Importance of billing and shipping addresses in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.

String (1)

<AppliedCategoryTime>

Importance of time of day in assessing the order. If you do not specify a value in your request, the server uses the default value for your merchant ID.

String (6)

<AppliedAVS>

Reserved for future use.

String (5)

<AppliedCV>

Reserved for future use.

String (1)

<BinAccountType>

Type of customer. This field can contain one of these values:

• CN: (Consumer) private customer

• CP: (Corporate) business customer

String (2)

<BinScheme>

Subtype of card account. This field can contain one of these values:

• Maestro International

• Maestro UK Domestic

• MasterCard Credit

• MasterCard Debit

• Solo

• Visa Credit

• Visa Debit

• Visa Electron

String (32)

<BinIssuer>

Name of the bank or entity that issued the card account.

String (128)

<BinCountry>

Country (two-digit country code) associated with the BIN of the customer’s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the Business Center.

String (2)

<IPCity>

Name of the city decoded from the IP address used directly or indirectly by the customer to send the order.

String (50)

<IPCountry>

Name of the country decoded from the IP address used directly or indirectly by the customer to send the order.

String (2)

<IPRoutingMethod>

Routing method decoded from the IP address used directly or indirectly by the customer to send the order. Routing method decoded from the IP address used directly or indirectly by the customer to send the order. This field can contain one of these values:

• Anonymizer

• AOL, AOL dial-up, AOL POP, and AOL proxy

• Cache proxy

• Fixed

• International proxy

• Mobile gateway

• POP

• Regional proxy

• Satellite

• SuperPOP

String (25)

<IPState>

Name of the state decoded from the IP address used directly or indirectly by the customer to send the order.

String (2)

<InfoCodes>

Information codes returned for the order. For a list of child elements, see <InfoCodes>.

 

Example <RiskData> element

<RiskData>

  <Factors>G,U</Factors>

  <HostSeverity>3</HostSeverity>

  <Score>17</Score>

  <AppliedThreshold>50</AppliedThreshold>

  <AppliedTimeHedge>Normal</AppliedTimeHedge>

  <AppliedVelocityHedge>Normal</AppliedVelocityHedge>

  <AppliedHostHedge>Normal</AppliedHostHedge>

  <AppliedCategoryGift>No</AppliedCategoryGift>

  <AppliedCategoryTime>Normal</AppliedCategoryTime>

  <BinAccountType>CN<BinAccountType>

  <BinScheme>Visa Credit</BinScheme>

  <BinIssuer>sample card issuer</BinIssuer>

  <BinCountry>US</BinCountry>

  <IPCity>Sample Town</IPCity>

  <IPCountry>US</IPCountry>

  <IPRoutingMethod>Fixed</IPRoutingMethod>

  <IPState>MI</IPState>

  <InfoCodes>...</InfoCodes>

</RiskData>

<InfoCodes>

The <InfoCodes> contain all the information codes that can be returned for an order.

Syntax

<InfoCodes>

  (InfoCode)+

</InfoCodes>

Table 49 Child Elements of <InfoCodes>

Element Name

Description

Data Type and Length

<InfoCode>

Specific information code returned for an order. For a list of child elements, see <InfoCode>.

 

Example <InfoCodes> element

<InfoCodes>

  <InfoCode>...</InfoCode>

</InfoCodes>

<InfoCode>

The <InfoCodes> contain all the information codes that can be returned for an order.

Syntax

<InfoCode Name=CDATA>

  (CodeValue)

  (CodeType)

</InfoCode>

Table 50 Child Elements of <InfoCode>

Element Name

Description

Data Type and Length

<CodeType>

Category of information code returned for an order. This element can contain one of these values:

• address

• hotlist

• identity

• internet

• merchant_velocity

• phone

• suspicious

• velocity

String (20)

<CodeValue>

Description of the information code returned in the <CodeType> element. For a description of the values, see Appendix H, Score Information Codes. For merchant_velocity, see the custom merchant velocity order and product rules and the corresponding information codes created for your implementation.

String (255)

Example <InfoCodes> element

<InfoCode>

  <CodeType>velocity</CodeType>

  <CodeValue>VEL-CC</CodeValue>

</InfoCode>

<ProfileList>

The <ProfileList> element contains detailed information about the evaluation of an order by Decision Manager.

Syntax

<ProfileList>
  (Profile)+>
</ProfileList>

Table 51 Child Elements of <ProfileList> in the Single Transaction Report

Element Name

Description

Data Type and Length

<Profile>

Profile used to evaluate an order. See <Profile>.

String (255)

Example <ProfileList> element

<ProfileList>

  <Profile> </Profile>

</ProfileList>

<Profile>

The <Profile> element contains detailed information about the profile used to evaluate an order.

Syntax

<Profile Name=CDATA>
  (ProfileMode)
  (ProfileDecision)
  (RuleList)?
</Profile>

Table 52 Attributes of <Profile> in the Single Transaction Report

Attribute Name

Description

Data Type and Length

Name

Name of the profile.

String (255)

Table 53 Child Elements of <Profile> in the Single Transaction Report

Element Name

Description

Data Type and Length

<ProfileMode>

Activity mode of the profile; this field contains one of these values:

• Active

• Passive

String (255)

<ProfileDecision>

Decision returned by the profile; this field contains one of these values:

• ACCEPT

• REJECT

• REVIEW

String

<RuleList>

List of rules used to evaluate an order. For a list of child elements, see <RuleList>.

String

Example <Profile> element

<Profile Name="Default Profile">

  <ProfileMode>Active</ProfileMode>

  <ProfileDecision>ACCEPT</ProfileDecision>

  <RuleList> ... </RuleList>

</Profile>

<RuleList>

The <RuleList> element lists all the rules in the profile.

Syntax

<RuleList>
  (Rule)*
</RuleList>

Table 54 Child Elements of <RuleList> in the Single Transaction Report

Element Name

Description

Data Type and Length

<Rule>

List of all the rules in the profile. For a list of child elements, see <Rule>.

String (255)

Example <RuleList> element

<RuleList>

  <Rule>

  </Rule>

  <Rule>

  </Rule>

  ...

</RuleList>

<Rule>

The <Rule> element contains information about the rules of the profile used to evaluate an order and the decision returned by each rule.

Syntax

<Rule>

  (RuleName)

  (RuleDecision)

</Rule>

Table 55 Child Elements of <Rule> in the Single Transaction Report

Element Name

Description

Data Type and Length

<RuleName>

Name of the rule

String (255)

<RuleDecision>

Decision returned by the rule. Possible values:

• Accept

• Reject

• Review

• Ignore

String (6)

Example <Rule> element

<Rule>

  <RuleName>Card Verification Number was not submitted.</RuleName>

  <RuleDecision>IGNORE</RuleDecision>

  <RuleName>Card issued outside of US (AVS indicator)</RuleName>

  <RuleDecision>Ignore</RuleDecision>

  ...

</Rule>

<TravelData>

The <TravelData> element contains all the information about the purchased trip and the passengers.

Syntax

<TravelData>

  (TripInfo)

  (PassengerInfo)?

</TravelData>

Table 56 Child Elements of <TravelData>

Element Name

Description

Data Type and Length

<TripInfo>

Information about the itinerary. For a list of the child elements, see <TripInfo>.

 

<PassengerInfo>

Information about the passengers. For a list of the child elements, see <PassengerInfo>.

 

Example <TravelData> element

<TravelData>

  <TripInfo>...</TripInfo>

  <PassengerInfo>...</PassengerInfo>

</TravelData>

<TripInfo>

The <TripInfo> element contains all the information about the itinerary.

Syntax

<TripInfo>

  (CompleteRoute)?

  (JourneyType)?

  (DepartureDateTime)?

</TripInfo>

Table 57 Child Elements of <TripInfo>

Element Name

Description

Data Type and Length

<CompleteRoute>

Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for example: SFO-JFK:JFK-LHR:LHR-CDG. For a complete list of airport codes, see IATA’s City Code Directory.

String (255)

<JourneyType>

Type of travel. For example, you can use values such as one way or round trip.

String (32)

<DepartureDateTime>

Departure date and time of the first leg of the trip in one of these formats:

• yyyy-MM-dd HH:mm z

• yyyy-MM-dd hh:mm a z

• yyyy-MM-dd hh:mma z

HH = hour in 24-hour format
hh = hour in 12-hour format
a = am or pm (case insensitive)
z = your time zone

DateTime (25)

Example <TripInfo> element

<TripInfo>

  <CompleteRoute>AB-CD:EF-GH</CompleteRoute>

  <JourneyType>round trip</JourneyType>

  <DepartureDateTime>2009-03-20 11:30 PM PDT</DepartureDateTime>

</TripInfo>

<PassengerInfo>

The <PassengerInfo> element contains all the passengers’ reference information.

Syntax

<PassengerInfo>

  (Passenger)*

</PassengerInfo>

Table 58 Child Elements of <PassengerInfo>

Element Name

Description

Data Type and Length

<Passenger>

Complete information about a passenger. For a list of the child elements, see <Passenger>.

 

Example <PassengerInfo> element

<PassengerInfo>

  <Passenger>...</Passenger>

</PassengerInfo>

<Passenger>

The <Passenger> element contains the complete information about a passenger.

Syntax

<Passenger Number=CDATA>

  (PassengerFirstName)?

  (PassengerLastName)?

  (PassengerID)?

  (PassengerStatus)?

  (PassengerType)?

  (PassengerPhone)?

  (PassengerEmail)?

</Passenger>

Table 59 Attribute of <Passenger>

Attribute Name

Description

Data Type and Length

Number

Offer level or rank of the passenger in the order.

Numeric (no limit)

Table 60 Child Elements of <TravelData>

Element Name

Description

Data Type and Length

<PassengerFirstName>

Passenger’s first name.

String (60)

<PassengerLastName>

Passenger’s last name.

String (60)

<PassengerID>

ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number.

String (32)

<PassengerStatus>

Your company's passenger classification, such as with a frequent flyer program. In this case, you might use values such as standard, gold, or platinum.

String (32)

<PassengerType>

Passenger classification associated with the price of the ticket. This element can contain one of these values:

• ADT: Adult

• CNN: Child

• INF: Infant

• YTH: Youth

• STU: Student

• SCR: Senior Citizen

• MIL: Military

String (32)

<PassengerPhone>

Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include the country code.

String (15)

<PassengerEmail>

Passenger's email address, including the complete domain name, such as jdoe@example.com.

String (255)

Example <Passenger> element

<Passenger Number="1">

  <PassengerFirstName>john</PassengerFirstName>

  <PassengerLastName>doe</PassengerLastName>

  <PassengerID>sing-002</PassengerID>

  <PassengerStatus>Adult</PassengerStatus>

  <PassengerType>Gold</PassengerType>

  <PassengerPhone>9995551212</PassengerPhone>

  <PassengerEmail>jdoe@example.com</PassengerEmail>

</Passenger>

Transaction Exception Detail Report

This report gives detailed information about transactions that were flagged by CyberSource or by the processor because of errors that were sent in the request of your follow-on transactions, such as captures and credits. For example, you might see errors such as a capture amount greater than the authorized amount and missing or invalid fields.

After reviewing and correcting the errors, you can resend the requests and then update your system to avoid these errors in the future.

Important Error notifications received from card processors during authorization attempts will continue to be reported immediately.

With the Global Payment Services, all errors associated with the primary and follow-on requests associated will be included in this report. For more information, see the Global Payment Services Planning and User’s Guide.

<Report>

The <Report> element is the root element of the report.

Syntax

<Report Name=CDATA
        Version=CDATA
        xmlns=CDATA>
        MerchantID=CDATA
        ReportStartDate=CDATA
        ReportEndDate=CDATA
  (Requests)
</Report>

Table 61 Attributes of <Report> in the Transaction Exception Detail Report

Attribute Name

Description

Data Type and Length

Name

Name of the report. This field always contains the text Transaction Exception Detail.

String (100)

Version

Version number of the report. The current version number is 1.0.

Numeric (10)

xmlns

XML namespace for the report. The namespace for the current version is https://ebc.cybersource.com/ebc/reports/dtd/ tedr.dtd.

String (100)

MerchantID

CyberSource merchant ID used for the transaction.

String (30)

ReportStart
Date

First date included in the report.

DateTime (25)

ReportEndDate

Last date included in the report.

DateTime (25)

Table 62 Child Element of <Report> in the Transaction Exception Detail Report

Element Name

Description

<Requests>

Contains all the requests in the report. See <Requests>.

Example <Report> Element

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Report SYSTEM "https://ebc.cybersource.com/ebc/reports/dtd/tedr.dtd">

<Report Name="Transaction Exception Detail"

        Version="1.0"

        xmlns="https://ebc.cybersource.com/ebc/reports/dtd/tedr.dtd"

        MerchantID="example"

        ReportStartDate="2006-05-20T05:00:00-05:00"

        ReportEndDate="2006-05-21T05:00:00-05:00

  <Requests>

    ...

  </Requests>

</Report>

<Requests>

The <Requests> element contains all the requests in the report.

Syntax

<Requests>
  (Request)*
</Requests>

Table 63 Child Elements of <Requests> in the Transaction Exception Detail Report

Element Name

Description

<Request>

Information about a single request. See <Request>.

Example <Requests> Element

<Requests>

  <Request>

    ...

  </Request>

</Requests>

<Request>

The <Request> element contains information about a single request. A request can include many CyberSource applications.

Syntax

<Request>
  (BasicInformation)
  (PaymentData)
  (PaymentMethod)
  (ErrorInformation)
  (BillTo)
  (ShipTo)?
</Request>

Table 64 Child Elements of <Request> in the Transaction Exception Detail Report

Element Name

Description

<BasicInformation>

Information, such as the request ID, that identifies the request. See <BasicInformation>.

<PaymentData>

Includes the amount and currency of the payment. See <PaymentData>.

<PaymentMethod>

Information about the payment method for the order. See <PaymentMethod>.

<ErrorInformation>

Information about the error that occurred. See <ErrorInformation>.

<BillTo>

Information about the billing address and purchaser for the order. See <BillTo>.

<ShipTo>

Information about the shipping address and recipient for the order. See <ShipTo>.

Example <Request> Element

<Request>

  <BasicInformation>

    ...

  </BasicInformation>

  <Amount>

  <PaymentMethod>

    ...

  </PaymentMethod>

  <ErrorInformation>

    ...

  </ErrorInformation>

  <BillTo>

    ...

  </BillTo>

  <ShipTo>

    ...

  </ShipTo>

<BasicInformation>

The <BasicInformation> element contains identifying information for the request.

Syntax

<BasicInformation>
  (RequestID)
  (TransactionDate)
  (MerchantReferenceNumber)
  (TransactionReferenceNumber)
  (TransactionType)
  (OriginalRequestID)
</BasicInformation>

Table 65 Child Elements of <BasicInformation> in the Transaction Exception Detail Report

Element Name

Description

Data Type and Length

<RequestID>

Unique identifier generated by CyberSource for the transaction.

Numeric (26)

<RequestDate>

Date when the transaction was processed.

DateTime (25)

<MerchantReferenceNumber>

Merchant-generated order reference or tracking number.

String (50)

<TransactionReferenceNumber>

Reference number that you use to reconcile your CyberSource reports with your processor reports. This field corresponds to the (Simple Order API) <service>_reconciliationID and to the (SCMP API) <service>_trans_ref_no reply fields.

String (60)

<TransactionType>

Type of transaction, such as credit card capture, credit, or bank transfer.

String (30)

<OriginalRequestID>

Request ID of the original transaction. For example, if the request that has an error is a refund, this field contains the request ID of the original payment.

Numeric (26)

Example <BasicInformation> Element

<BasicInformation>

  <RequestID>1406253049220167904565</RequestID>

  <TransactionDate>2006-02-22T16:21:44-08:00</RequestDate>

  <MerchantReferenceNumber>1140625304845</MerchantReferenceNumber>

  <TransactionReferenceNumber>02YZPT2EOGDX3D</TransactionReferenceNumber>

  <TransactionType>Credit card capture</TransactionType>

  <OriginalRequestID>1406235110599167904565</OriginalRequestID>

</BasicInformation>

<PaymentData>

The <PaymentData> element lists the amount and currency for the transaction.

Syntax

<PaymentData>
  (Amount)
  (CurrencyCode)?
</PaymentData>

Table 66 Child Elements of <PaymentData> in the Transaction Exception Detail Report

Element Name

Description

Data Type and Length

<Amount>

Amount specified in the request.

Amount (19)

<CurrencyCode>

Optional ISO currency code used for the transaction.

String (5)

Example <PaymentData> Element

<PaymentData>

  <Amount>30.00</Amount>

  <Currency>USD</Currency>

</PaymentData>

<PaymentMethod>

The <PaymentMethod> element contains information about the payment method for the order.

Syntax

<PaymentMethod>
  (AccountSuffix)?
  (BankCode)?
  (BankAccountName)?
  (ExpirationMonth)?
  (ExpirationYear)?
  (CardType)?
</PaymentMethod>

Table 67 Child Elements of <PaymentMethod> in the Transaction Exception Detail Report

Element Name

Description

Data Type and Length

<AccountSuffix>

Last four characters of the account number.

String (4)

<BankCode>

Bank code or sort code for the account if a bank account was used for the transaction.

String (15)

<BankAccountName>

Name of account holder.

String (60)

<ExpirationMonth>

If a credit card was used for the transaction, expiration month of the card (MM).

Numeric (2)

<ExpirationYear>

If a credit card was used for the transaction, expiration year of the card (YYYY).

Numeric (4)

<CardType>

Type of card or bank account. For the possible values, see Appendix E, Types of Cards and Bank Accounts.

String (50)

Example <PaymentMethod> element for a direct debit or bank transfer

<PaymentMethod>

  <AccountSuffix>4409</AccountSuffix>

  <BankCode>20-00-00</BankCode>

  <BankAccountName>John Smith</BankAccountName>

</PaymentMethod>

Example <PaymentMethod> element for a card transaction

<PaymentMethod>

  <AccountSuffix>4409</AccountSuffix>

  <ExpirationMonth>10</ExpirationMonth>

  <ExpirationYear>2010</ExpirationYear>

  <CardType>Visa</CardType>

</PaymentMethod>

<ErrorInformation>

The <ErrorInformation> element contains information about the error that occurred for the transaction.

Syntax

<ErrorInformation>
  (PaymentProcessor)?
  (Action)?
  (ErrorCategory)?
  (ErrorMessage)?
  (ReasonCode)?

  (ProcessorResponseCode)?
</ErrorInformation>

Table 68 Child Elements of <ErrorInformation> in the Transaction Exception Detail Report

Element Name

Description

Data Type and Length

<PaymentProcessor>

See Appendix D, Payment Processors.

String (40)

<Action>

Brief description of the action. Possible values:

• ERROR

• FAILED

• CANCELLED

String (15)

<ErrorCategory>

Type of error. Possible values:

• Data Error

• Failure

• Processor Error

• Settlement Error

String (20)

<ErrorMessage>

Description of the error.

String (255)

<ReasonCode>

Reason code for the error that occurred. This reason code is the same one that you receive in the reply or transaction receipt. See Appendix F, Reason Codes in the Transaction Exception Detail Report.

Numeric (3)

<ProcessorResponseCode>

Code returned directly from the processor for the error that occured.

String (60)

Example <ErrorInformation> Element

<ErrorInformation>

  <PaymentProcessor>sample processor</PaymentProcessor>

  <ErrorCategory>Failure</ErrorCategory>

  <ErrorMessage>The request ID is invalid.</ErrorMessage>

  <ReasonCode>241</ReasonCode>

  <ProcessorResponseCode>02</ProcessorResponseCode>

</ErrorInformation>

<BillTo>

The <BillTo> element contains information about the billing address and purchaser for the order.

Syntax

<BillTo>
  (FirstName)
  (LastName)
  (Address1)
  (Address2)?
  (City)
  (State)?
  (PostalCode)
  (Country)
  (CompanyName)?
  (Email)
  (Phone)
</BillTo>

Table 69 Child Elements of <BillTo> in the Transaction Exception Detail Report

Element Name

Description

Data Type and Length

<FirstName>

First name of the billed customer.

String (60)

<LastName>

Last name of the billed customer.

String (60)

<Address1>

First line of the billing address.

String (60)

<Address2>

Second line of the billing address.

String (60)

<City>

City of the billing address.

String (50)

<State>

State, province, or territory of the billing address.

String (20)

<PostalCode>

Postal code of the billing address.

String (10)

<Country>

ISO country code of the billing address.

String (2)

<CompanyName>

Company name of the billing address.

String (60)

<Email>

Email address of the bill-to customer.

String (255)

<Phone>

Phone number of the billed customer.

String (15)

Example <BillTo> Element

<BillTo>

  <FirstName>John</FirstName>

  <LastName>Doe</LastName>

  <Address1>1295 Charleston Rd.</Address1>

  <City>Mountain View</City>

  <State>CA</State>

  <PostalCode>94043</PostalCode>

  <Country>US</Country>

  <Email>example@example.com</Email>

  <Phone>650-965-6000</Phone>

</BillTo>

<ShipTo>

The <ShipTo> element contains information about the shipping address and recipient for the order.

Syntax

<ShipTo>
  (FirstName)?
  (LastName)?
  (Address1)?
  (Address2)?
  (City)?
  (State)?
  (PostalCode)?
  (Country)?
</ShipTo>

Table 70 Child Elements of <ShipTo> in the Transaction Exception Detail Report

Element Name

Description

Data Type and Length

<FirstName>

First name of the customer receiving the shipment.

String (60)

<LastName>

Last name of the customer receiving the shipment.

String (60)

<Address1>

First line of the shipping address.

String (60)

<Address2>

Second line of the shipping address.

String (60)

<City>

City of the shipping address.

String (60)

<State>

State, province, or territory of the shipping address.

String (50)

<PostalCode>

Postal code of the shipping address.

String (10)

<Country>

ISO country code of the shipping address.

String (2)

Example <ShipTo> Element

<ShipTo>

  <Address1>1295 Charleston Rd.</Address1>

  <City>Mountain View</City>

  <State>CA</State>

  <PostalCode>94043</PostalCode>

  <Country>US</Country>

</ShipTo>

User Management Report

This report provides information about the permissions and roles granted to users.

<Report>

<Report> is the root element of the report.

Syntax

<Report Name=CDATA
        ReportDate=CDATA
        Version=NMTOKEN
        xmlns=CDATA>
  (Users)
</Report>

Table 71 Attributes of <Report> in the User Management Report

Attribute Name

Description

Data Type and Length

Name

Name of the report. This element always contains the text User Listing.

String (100)

ReportDate

Date and time when the report was run.

DateTime (25)

Version

Version number of the report. The current version number is 1.0.

Numeric (10)

xmlns

XML namespace for the DTD: https://ebc.cybersource.com/ebc/reports/dtd/ul.dtd.

String (100)

Table 72 Child Element of <Report> in the User Management Report

Element Name

Description

<Users>

Information about each user. See <Users>.

Example <Report> Element

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE Report SYSTEM "https://ebc.cybersource.com/ebc/reports/dtd/ul.dtd">

<Report Name="User Listing"

Version="1.0"

xmlns="https://ebc.cybersource.com/ebc/reports/dtd/ul.dtd"

        ReportDate="2007-09-21 05:31 GMT">

</Report>

<Users>

The <Users> element contains all of the users from a report date.

Syntax

<Users>
  (User)*
</Users>

Table 73 Child Element of <Users> in the User Management Report

Element Name

Description

<User>

Information about a user. See <User>.

Example <Users> Element

<Users>

  <User>

    ...

  </User>

</Users>

<User>

The <User> element contains information about a user.

Syntax

<User username CDATA #REQUIRED
      merchantid CDATA #REQUIRED
      firstname CDATA #REQUIRED
      lastname CDATA #REQUIRED
      email CDATA #IMPLIED
      datecreated CDATA #REQUIRED
      lastaccess CDATA #REQUIRED
      status CDATA #REQUIRED
      role CDATA #REQUIRED>
  (Permissions)
</User>

Table 74 Attributes of <User> in the User Management Report

Attribute Name

Description

Data Type and Length

username

Unique identifier for the user.

String (50)

merchantid

CyberSource merchant ID used for the transactions in the report.

String (30)

firstname

User's first name.

String (60)

lastname

User's last name.

String (60)

email

Optional email address of the user.

String (255)

datecreated

Date when the user was created.

DateTime (25)

lastaccess

Date when the user most recently logged in the Business Center.

DateTime (25)

status

Activity status of the user:

• enabled: user can perform tasks according to permissions granted.

• disabled: user cannot log in the Business Center.

String

role

Named collection of single permissions that describe the tasks assigned to a user, such as admin or custom.

String

Table 75 Child Element of <User> in the User Management Report

Element Name

Description

<Permissions>

Information about the permissions granted to a user. See <Permissions>.

Example <User> Element

<User username="infodev_user"

      merchantid="infodev"

      firstname="Jane"

      lastname="Doe"

      email=""

      datecreated="2007-03-29 07:47 GMT"

      lastaccess="2007-09-21 04:26 GMT"

      status="Enabled"

      role="Custom">

   <Permissions>

   </Permissions>

</User>

<Permissions>

The <Permissions> element contains information about the permissions granted to the user.

Syntax

<Permissions>
  (Permission)*
</Permissions>

Table 76 Child Element of <Permissions> in the User Management Report

Element Name

Description

<Permission>

Each permission granted to the user. See <Permission>.

Example <Permissions> Element

<Permissions>

  <Permission>

    ...

  </Permission>

</Permissions>

<Permission>

The <Permission> element contains information about each permission granted to the user.

Syntax

<Permission EMPTY name CDATA #REQUIRED
</Permission>

Table 77 Attribute of <Permission> in the User Management Report

Attribute Name

Description

Data Type and Length

<Name>

Name of each permission granted to the user.

String

Example <Permission> Element

<Permission name="Virtual Terminal Transaction"/>

<Permission name="Payment Authorization"/>