Cybersource Message Layouts

Cybersource Token Request (paySubscriptionCreate) XML Message

Cybersource Token Response (paySubscriptionCreate) XML Message

Cybersource Authorization Request (ccAuthService) XML Message

Cybersource Authorization Response (ccAuthService) XML Message

Cybersource Token and Authorization Request (paySubscriptionCreate and ccAuthService) XML Message

Cybersource Token and Authorization Response (paySubscriptionCreate and ccAuthService) XML Message

Cybersource Debit Deposit Request (ccCaptureService) XML Message

Cybersource Debit Deposit Response (ccCaptureService) XML Message

Cybersource Credit Deposit Request (ccCreditService) XML Message

Cybersource Credit Deposit Response (ccCreditService) XML Message

Cybersource Authorization and Deposit Request (ccAuthService and ccCaptureService) XML Message

Cybersource Authorization and Deposit Response (ccAuthService and ccCaptureService) XML Message

Cybersource Authorization Reversal Request (ccAuthReversalService) XML Message

Cybersource Authorization Reversal Response (ccAuthReversalService) XML Message

Cybersource Token Request (paySubscriptionCreate) XML Message

The Cybersource Token Request (paySubscriptionCreate) XML message is used to request a token from Cybersource. See Credit Card Tokenization in the Data Security and Encryption Guide for processing details.

Note: Cybersource refers to a token as a customer profile which has a submitter’s ID or token.

Sample transaction: See Cybersource Token (paySubscriptionCreate) Transaction: Sample Messages.

Special characters: Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. Order Management System replaces the following special characters with the text strings listed below.

Special Character

Description

Replacement Text String

single quote

'

"

double quote

"

>

greater than

>

<

less than

&lt;

&

ampersand

&amp;

Order Management System also removes any non-standard keyboard characters from the XML message before sending it to Cybersource.

The elements and attributes of the Cybersource Token Request (paySubscriptionCreate) XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

requestMessage

merchantID

The account number assigned by Cybersource to identify transmissions. From the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

merchantReferenceCode

The company code + order number. If the request is not associated with an order, the order number is zero-filled. From the Company and Order # fields in the Order Payment Method table.

billTo

Cybersource performs address verification against the bill to name and address included in the Token Request.

firstName

The bill to customer’s first name. From the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

lastName

The bill to customer’s last name. From the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold to table.

Note: If a last name is not passed, Cybersource fails the transaction.

street1

The street address on the bill to customer’s address, followed by the text APT and the apartment or suite number defined for the bill to customer’s address. For example: 123 MAIN ST APT 2B. From the:

Street address and APT Code in the Customer Bill To table, or

NAM Street address and Apartment in the Customer Sold To table.

street2

The second address line on the bill to customer’s address. From the:

Address line 2 field in the Customer Bill To table, or

NAM Address line 2 in the Customer Sold To table.

city

The city on the bill to address. From the:

City field in the Customer Bill To table, or

City field in the Customer Sold To table.

state

The state code on the bill to customer’s address. From the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

postalCode

The zip code on the bill to customer’s address.

If the country code is US, the 9-digit zip code is in 99999-9999 format.

If the country code is CA, the 6-digit zip code is in A1B 2C3.

If the country code is JP, the 7-digit zip code is in 999-9999 format.

If the country code is GB, the 6-digit zip code is in AB12CD format.

From the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

The country code on the bill to customer’s address. The system uses the Work with Authorization Service Country Screen to cross-reference the Order Management System country code in the Customer Bill To table or Customer Sold To table to the Cybersource country code.

From the Auth Service Country field in the Auth Service Country table.

email

The bill to customer’s email address.

If an email address is not defined for the bill to customer, null@Cybersource.com defaults.

From the CST email address field in the Customer Sold To table.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

From the ASC Currency code field in the Auth Service Currency table.

card

Cybersource validates the credit card information included in the Token Request.

accountNumber

The card number to replace with a token.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

From the OPM credit card number field in the Order Payment Method table.

expirationMonth

The month when the card expires, in MM format.

From the first 2 positions of the OPM expiration date field in the Order Payment Method table.

expirationYear

The year when the card expires, in YYYY format.

From the last 2 positions of the OPM expiration date field in the Order Payment Method table.

cardType

The vendor paytype code defined for the credit card pay type. This is the code Cybersource uses to identify the method of payment.

From the CPC vendor paytype/code field in the CC Paytype Cross Ref table.

cvIndicator

The card identification indictor defined for the card, indicating if a CID number has been defined. Valid values:

1 = CID number is present on card.

2 = CID number is present on card, but is illegible.

9 = CID number is not present on card.

Included only for online transactions.

cvNumber

The card identification number defined for the card.

Visa, MasterCard, Discover: The card identification number is a 3 digit number.

American Express: The card identification number is a 4 digit number.

Note: The card identification number is available only for online transactions; once an order is accepted, the system removes the card identification number from the order.

issueNumber

The card issue number defined for the card being processed.

From the OPM card issue # field in the Order Payment Method table.

startMonth

The start month defined for the card being processed, in MM format.

From the first 2 positions of the Start date field in the Order Payment Method table.

startYear

The start year defined for the card being processed, in YYYY format.

From the last 2 positions of the Start date field in the Order Payment Method table.

decisionManager

enabled

false defaults.

recurringSubscriptionInfo

frequency

on-demand defaults.

paySubscriptionCreate

Service_run

true defaults, indicating the message is for a token request.

Cybersource Token Response (paySubscriptionCreate) XML Message

The Cybersource Token Response (paySubscriptionCreate) XML message contains the response from Cybersource for the Cybersource Token Request (paySubscriptionCreate) XML Message.

Sample transaction: See Cybersource Token (paySubscriptionCreate) Transaction: Sample Messages.

The elements and attributes of the Cybersource Token Response (paySubscriptionCreate) XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

replyMessage

The response returned by Cybersource indicates whether the token request was accepted or rejected. If the transaction was accepted, Cybersource returns a token in the requestToken tag.

merchantReferenceCode

The company code + order number, used to match the response to the request. If the request is not associated with an order, the order number is zero-filled.

Corresponds to the Company and Order # fields in the Order Payment Method table.

requestID

A code assigned by Cybersource to match this response to subsequent transactions.

decision

ACCEPT indicates Cybersource approved the transaction.

ERROR indicates an error occurred while Cybersource was processing the transaction.

REJECT indicates Cybersource rejected the transaction.

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestToken

The credit card number requesting tokenization, encrypted.

Updates the OPM credit card number field in the Order Payment Method table.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

Corresponds to the ASC Currency code field in the Auth Service Currency table.

ccAuthReply

Cybersource returns authorization information in the Token Response; however, Order Management System ignores this information.

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

Corresponds to the Response Code field in the CC Vendor Response table.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

amount

0.00 defaults for token transactions.

authorizationCode

The authorization code assigned to the transaction.

avsCode

The AVS code assigned to the transaction.

avsCodeRaw

The AVS code assigned to the transaction.

cvCode

The card identification response for the credit card.

authorizedDateTime

The date and time when the transaction was processed, in YYYY-MM-DDTHH:MM:SSZ format.

processorResponse

The response code from the bank. Informational only.

reconciliationID

A code assigned by Cybersource as a reference number for the transaction.

paySubscriptionCreateReply

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

Corresponds to the Response Code field in the CC Vendor Response table.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

subscriptionID

The token assigned to the credit card payment.

Cybersource uses this code to reference the customer profile information in the Cybersource database.

Cybersource Authorization Request (ccAuthService) XML Message

The Cybersource Authorization Request XML message is used to authorize a credit card payment.

Sample transaction: See:

Cybersource Authorization (ccAuthService) Transaction without Decision Manager: Sample Messages

Cybersource Authorization (ccAuthService) Transaction with Decision Manager: Sample Messages

Special characters: Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. Order Management System replaces the following special characters with the text strings listed below.

Special Character

Description

Replacement Text String

single quote

&apos;

"

double quote

&quot;

>

greater than

&gt;

<

less than

&lt;

&

ampersand

&amp;

Order Management System also removes any non-standard keyboard characters from the XML message before sending it to Cybersource.

The elements and attributes of the ccAuthService Request XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

requestMessage

merchantID

The account number assigned by Cybersource to identify transmissions. From the:

CYB_PAY_LINK_DECISION_MANAGER_MERCHANT_ID_OVERRIDE property, or

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

merchantReferenceCode

The company code + order number + order payment method sequence number.

From the Company, Order # and OPM Seq # fields in the Order Payment Method table.

billTo

Included if:

• you send the credit card number and not a token provided by Cybersource

• the CYB_PAY_LINK_DECISION_MANAGER_ENABLED setting in the Cybersource Interface Properties is set to true

firstName

The bill to customer’s first name. From the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

lastName

The bill to customer’s last name. From the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold to table.

Note: If a last name is not passed, Cybersource fails the transaction.

street1

The street address on the bill to customer’s address, followed by the text APT and the apartment or suite number defined for the bill to customer’s address. For example: 123 MAIN ST APT 2B. From the:

Street address and APT Code in the Customer Bill To table, or

NAM Street address and Apartment in the Customer Sold To table.

street2

The second address line on the bill to customer’s address. From the:

Address line 2 field in the Customer Bill To table, or

NAM Address line 2 in the Customer Sold To table.

city

The city on the bill to address. From the:

City field in the Customer Bill To table, or

City field in the Customer Sold To table.

state

The state code on the bill to customer’s address. From the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

postalCode

The zip code on the bill to customer’s address.

If the country code is US, the 9-digit zip code is in 99999-9999 format.

If the country code is CA, the 6-digit zip code is in A1B 2C3.

If the country code is JP, the 7-digit zip code is in 999-9999 format.

If the country code is GB, the 6-digit zip code is in AB12CD format.

From the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

The country code on the bill to customer’s address. The system uses the Work with Authorization Service Country Screen to cross-reference the Order Management System country code in the Customer Bill To table or Customer Sold To table to the Cybersource country code.

From the Auth Service Country field in the Auth Service Country table.

phoneNumber

The bill to customer’s day phone number.

From the:

CT# Phone field in the Customer Bill To Phone # table for Phone # type D, or

CS# Phone field in the Customer Sold To Phone # table for Phone # type D.

email

The bill to customer’s email address.

If an email address is not defined for the bill to customer, null@Cybersource.com defaults.

From the CST email address field in the Customer Sold To table.

customerID

The Order Management System sold to customer number.

From the CST Customer # field in the Customer Sold To table.

customerPassword

The customer’s account password, used for merchant velocity use only and it not stored, displayed, or returned.

Note: This field is not currently implemented in the Order Management System integration with Cybersource.

personalID

Personal identifier, supported only for Cybersource Latin American Processing.

Note: This field is not currently implemented in the Order Management System integration with Cybersource.

shipTo

Included if the CYB_PAY_LINK_DECISION_MANAGER_ENABLED property is set to true.

The shipTo is different from the billTo if the customer specified an alternate shipping address on the order:

• order ship to: see Assigning an Order Shipping Address

• permanent ship to: see Using a Permanent Shipping Address in Order Entry

• recipient customer: see Adding a Recipient Order in Order Entry

firstName

The ship to customer’s first name. From the:

First name field in the Customer Ship To table, or

NAM First name field in the Customer Sold To table.

lastName

The ship to customer’s last name. From the:

Last name field in the Customer Ship To table, or

NAM Last name field in the Customer Sold to table.

Note: If a last name is not passed, Cybersource fails the transaction.

street1

The street address on the ship to customer’s address, followed by the text APT and the apartment or suite number defined for the ship to customer’s address. For example: 123 MAIN ST APT 2B. From the:

Street address and Apartment in the Customer Ship To table, or

NAM Street address and Apartment in the Customer Sold To table.

street2

The second address line on the ship to customer’s address. From the:

Address line 2 field in the Customer Ship To table, or

NAM Address line 2 in the Customer Sold To table.

city

The city on the ship to address. From the:

City field in the Customer Ship To table, or

City field in the Customer Sold To table.

state

The state code on the ship to customer’s address. From the:

State field in the Customer Ship To table, or

NAM State field in the Customer Sold To table.

postalCode

The zip code on the ship to customer’s address.

If the country code is US, the 9-digit zip code is in 99999-9999 format.

If the country code is CA, the 6-digit zip code is in A1B 2C3.

If the country code is JP, the 7-digit zip code is in 999-9999 format.

If the country code is GB, the 6-digit zip code is in AB12CD format.

From the:

Zip field in the Customer Ship To table, or

NAM Zip field in the Customer Sold To table.

country

The country code on the ship to customer’s address. The system uses the Work with Authorization Service Country Screen to cross-reference the Order Management System country code in the Customer Ship To table or Customer Sold To table to the Cybersource country code.

From the Auth Service Country field in the Auth Service Country table.

phoneNumber

The ship to customer’s day phone number.

From the:

CT# Phone field in the Customer Ship To Phone # table for Phone # type D, or

CS# Phone field in the Customer Sold To Phone # table for Phone # type D.

shippingMethod

The service level defined for the ship to customer’s zip code.

Service levels defined in Cybersource Decision Manager are:

sameday: Courier or same day service.

oneday: Next day or overnight service.

twoday: Two day service.

threeday: Three day service.

lowcost: Lowest cost service

pickup: Store pickup. When a ShippingMethod is defined for a ship to in the ccAuthService message, the shipping address is not automatically added to the negative list. You can add a shipping address to the negative list using the Transaction Marking Tool; see Marking Order Data During Order Review in the Case Management section of the Decision Manager User Guide.

other: Other shipping method.

none: No shipping method because product is a service or subscription.

Note: To use a custom value, create a Decision Manager custom rule with the shipping method order element.

From the Service Level field in the Ship Via table.

item

Included if the CYB_PAY_LINK_DECISION_MANAGER_ENABLED property is set to true.

id

The number of items on the order, starting with 0. For example, if two items are on the order, the first item would be set to 0 and the second item would be set to 1.

unitPrice

The unit selling price of the product.

From the ODT Price field in the Order Detail table.

quantity

The quantity of the product being purchased.

From the ODT qty reserved field in the Order Detail table.

productCode

The type of product.

Product codes used by Cybersource services are:

adult_content: Adult content.

coupon: Coupon applied to the entire order.

default: Product classification has not been defined for the product.

electronic_good: Electronic product other than software.

electronic_software: Software distributed electronically rather than on disks or other media.

handling_only: Fee that you charge the customer to cover administrative selling costs.

service: Service that you perform for the customer.

shipping_and_handling: The shipping portion is the charge for shipping the product to the customer. The handling portion is the fee you charge the customer to cover your administrative selling costs.

shipping_only: Charge for transporting tangible personal property from your location to the customer. You must maintain documentation that clearly establishes the location where the title to the property passed from you to the customer.

subscription: Subscription to a web site or other content.

The setting of the Product Classification for Fraud Scoring (M15) system control value determines whether Order Management System sends the item’s item class description or item category description to Cybersource.

• If set to ITM CLASS, from the ICL description field in the Item Class table.

• If set to ITM CATGRY, from the Item category description field in the Item Category table.

productName

The name of the product.

If the item is a non-SKUed item, this is the item description.

If the item is a SKUed item, this is a concatenation of the item description + SKU description.

From the Description field in the Item table + the Description field in the SKU table.

productSKU

Merchant’s product identifier code.

If the item is a non-SKUed item, this is the item number.

If the item is a SKUed item, this is a concatenation of the item number + SKU code.

From the ITM Number field and SKU Code field in the SKU table.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

From the ASC Currency code field in the Auth Service Currency table.

grandTotalAmount

The amount to authorize, including decimals, in the currency defined on the order.

Online transactions: From the OLA auth amt field in the Online Authorization table.

Batch transactions: From the Auth $ amt field in the CC Authorization Trans table.

recurringSubscriptionInfo

Included only if the credit card number has been replaced with a token provided by Cybersource.

subscriptionID

The token for the credit card payment.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

From the OPM credit card number field in the Order Payment Method table.

frequency

on-demand defaults.

card

Included if you send the credit card number and not a token provided by Cybersource.

accountNumber

The card number to authorize and replace with a token.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

From the OPM credit card number field in the Order Payment Method table.

expirationMonth

The month when the card expires, in MM format.

From the first 2 positions of the OPM expiration date field in the Order Payment Method table.

expirationYear

The year when the card expires, in YYYY format.

From the last 2 positions of the OPM expiration date field in the Order Payment Method table.

cardType

The vendor paytype code defined for the credit card pay type. This is the code Cybersource uses to identify the method of payment.

From the CPC vendor paytype/code field in the CC Paytype Cross Ref table.

cvIndicator

The card identification indicator defined for the card, indicating if a CID number has been defined. Valid values:

1 = CID number is present on card.

2 = CID number is present on card, but is illegible.

9 = CID number is not present on card.

Included only for online transactions.

cvNumber

The card identification number defined for the card.

Visa, MasterCard, Discover: The card identification number is a 3 digit number.

American Express: The card identification number is a 4 digit number.

Note: The card identification number is available only for online transactions; once an order is accepted, the system removes the card identification number from the order.

issueNumber

The card issue number defined for the card being processed.

From the OPM card issue # field in the Order Payment Method table.

startMonth

The start month defined for the card being processed, in MM format.

From the first 2 positions of the Start date field in the Order Payment Method table.

startYear

The start year defined for the card being processed, in YYYY format.

From the last 2 positions of the Start date field in the Order Payment Method table.

merchantDefinedData

The merchantDefinedData fields can be used to store many types of information that may be unique to your business.

Note: The merchantDefinedData fields are not currently implemented in the Order Management System integration with Cybersource. Contact your Order Management System representative if you would like to implement these fields in the Order Management System integration with Cybersource.

See Potential Uses for Merchant-Defined Data Fields in the Cybersource Decision Manager Developer Guide for examples of the type of information that can be captured in these fields.

merchantDefinedData_mddField_1 tomerchantDefinedData_mddField_100

Optional fields that you can use to store information.

The value appears in the Case Management Details window in the Business Center.

Merchant defined fields cannot be used to capture personally identifying information.

These fields can only be used if you are referencing target API version 1.75 or higher.

decisionManager

enabled

true defaults if the CYB_PAY_LINK_DECISION_MANAGER_ENABLED property is set to true. In this situation, Cybersource Decision Manager evaluates the transaction for possible fraud. See Cybersource Decision Manager Fraud Scoring for processing details.

false defaults if the CYB_PAY_LINK_DECISION_MANAGER_ENABLED property is set to any value other than true.

profile

Allows you to specify the name of a different profile to use to evaluate orders.

Note: This field is not currently implemented in the Order Management System integration with Cybersource.

ccAuthService

ccAuthService_run

true defaults.

commerceIndicator

internet defaults if the E-Commerce indicator (Future use status 1) field in the Order Header table is set to I or the order type for the order matches the order type defined in the E-Commerce Order Type (G42) system control value; otherwise, moto defaults.

cavv

A code received from an authentication service, such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating whether the card authentication password the cardholder provided was approved for the credit card. See Credit Card Authentication Service for more information.

From the Authentication value field in the Order Payment Method table.

eciRaw

A code received from an authentication service, such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating whether the card authentication password the cardholder provided was approved for the credit card. See Credit Card Authentication Service for more information.

From the Authentication value field in the Order Payment Method table.

businessRules

ignoreAVSResult

true defaults.

ignoreCVResult

true defaults.

Cybersource Authorization Response (ccAuthService) XML Message

The Cybersource Authorization Response XML message contains the response from Cybersource for the Cybersource Authorization Request (ccAuthService) XML Message.

Sample transaction: See:

Cybersource Authorization (ccAuthService) Transaction without Decision Manager: Sample Messages

Cybersource Authorization (ccAuthService) Transaction with Decision Manager: Sample Messages

The elements and attributes of the ccAuthService Response XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

replyMessage

merchantReferenceCode

The company code + order number + order payment method sequence number, used to match the response to the correct request.

Corresponds to the Company, Order # and OPM Seq # fields in the Order Payment Method table.

requestID

The unique transaction ID assigned by Cybersource for the transaction.

Updates the Transaction ID field in the Authorization History table.

decision

The overall decision for the entire request from Decision Manager.

ACCEPT indicates Cybersource approved the transaction.

REVIEW indicates Cybersource Decision Manager marked the order for review for further analysis. The credit card authorization remains approved and valid, but the order may or may not be processed at a later time. See Cybersource Decision Manager Review Process for more information.

ERROR indicates an error occurred while Cybersource was processing the transaction.

REJECT indicates Cybersource Decision Manager rejected the transaction. Order Management System deactivates the credit card payment and requires you to add another form of payment before you can accept the order. See Cybersource Decision Manager Reject Process for more information.

reasonCode

The reason the transaction was approved or rejected by Decision Manager.

Corresponds to the Response Code field in the CC Vendor Response table.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

400 indicates the fraud score exceeds your threshold.

480 indicates the order is marked for review by Decision Manager.

481 indicates the order is rejected by Decision Manager.

See the Cybersource documentation for a complete list of valid reason codes.

requestToken

The token assigned to the credit card associated with the authorization transaction, encrypted.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

Corresponds to the ASC Currency code field in the Auth Service Currency table.

ccAuthReply

reasonCode

The reason the authorization transaction was approved or rejected by the authorization service.

Corresponds to the Response Code field in the CC Vendor Response table and updates the AUH vendor response field in the Authorization History table.

100 indicates the transaction was successful.

Corresponds to the Response Code field in the CC Vendor Response table.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

See the Cybersource documentation for a complete list of valid reason codes.

amount

The amount authorized by Cybersource, including decimals, in the currency defined on the order.

Updates the AUH amount authorized field in the Authorization History table.

authorizationCode

The authorization number provided by Cybersource.

Updates the AUH auth # field in the Authorization History table.

avsCode

The address verification response for the credit card.

Updates the AUH AVS response field in the Authorization History table.

avsCodeRaw

The address verification response for the credit card, from the processor.

cvCode

The card identification response for the credit card.

Updates the AUH Vendor Response 2 field in the Authorization History table.

authorizedDateTime

The date and time the credit card was authorized, in YYYY-MM-DDTHH:MM:SSZ format.

Updates the AUH auth date field in the Authorization History table.

processorResponse

The response code from the bank. Informational only.

reconciliationID

A code assigned by Cybersource as a reference number for the transaction.

ownerMerchantID

The account number assigned by Cybersource to identify transmissions. Corresponds to the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

afsReply

Cybersource Advanced Fraud Screen reply. Informational only; these fields are not implemented in the Order Management System integration with Cybersource.

Included if the CYB_PAY_LINK_DECISION_MANAGER_ENABLED setting in the Cybersource Interface Properties is set to true.

reasonCode

Numeric value corresponding to the result of the Advanced Fraud Screen request.

afsResult

Total score calculated for the order.

hostSeverity

The risk associated with the customer’s email domain. From 0-5, where 0 represents an undetermined risk and 5 represents the highest risk.

consumerLocalTime

Customer’s local time in HH:MM:SS format. Calculated from the request time and the customer’s billing address.

afsFactorCode

Information that affected the score of the order. This field can contain one or more codes, separated by carets (^), for example: B^Y.

See Risk Factor Codes in the Cybersource Decision Manager Developer Guide for a list of factor codes used by Cybersource.

addressInfoCode

Indicates a mismatch between the customer’s billing and shipping addresses. This field can contain one or more codes, separated by carets (^).

See Address Information Codes in the Cybersource Decision Manager Developer Guide for a list of address info codes used by Cybersource.

internetInfoCode

Indicates a problem with the customer’s email address, IP address, or billing address. This field can contain one or more codes, separated by carets (^). See Information Codes in the Cybersource Decision Manager Developer Guide for a list of possible values.

suspiciousInfoCode

Indicates that the customer provided potentially suspicious information. This field can contain one or more codes, separated by carets (^), for example: INTL-BIN^RISK-T.

See Suspicious Data Information Codes in the Cybersource Decision Manager Developer Guide for a list of suspicious info codes used by Cybersource.

velocityInfoCode

Indicates that the customer has a high order velocity (purchase frequency). This field can contain one or more codes, separated by carets (^), for example: VELV-SA^VELI-CC^VELSIP.

scoreModelUsed

Name of the score model used for the transaction.

binCountry

Two-digit country code associated with the BIN of the customer’s card used for the payment.

cardAccountType

Type of payment card account, such as credit card, debit card, or prepaid card account type.

cardScheme

Subtype of card account.

• Maestro International

• Maestro UK Domestic

• MasterCard Credit

• MasterCard Debit

• Visa Credit

• Visa Debit

• Visa Electron

cardIssuer

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

decisionReply

Cybersource Decision Manager reply. Informational only; these fields are not implemented in the Order Management System integration with Cybersource.

activeProfileReply_

destinationQueue

When verbose mode is enabled, name of the queue where orders that are not automatically accepted are sent.

activeProfileReply_name

When verbose mode is enabled, name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen.

activeProfileReply_

rulesTriggered_

ruleResultItem_#_

decision

When verbose mode is enabled, summarizes the result for the rule specified according to the setting that you chose in the Profile Editor. This field contains one of the following values:

• ACCEPT

• ERROR

• REJECT

• REVIEW

activeProfileReply_

rulesTriggered_

ruleResultItem_#_

evaluation

When verbose mode is enabled, raw evaluation result of the rule specified by the number #. This field contains one of the following values:

• T: The rule is true.

• F: The rule is false.

• N: The rule cannot be evaluated because the data is insufficient.

• E: The rule cannot be evaluated because an

error occurred.

activeProfileReply_

rulesTriggered_

ruleResultItem_#_name

When verbose mode is enabled, description of the rule as it appears in the Profile Editor.

activeProfileReply_

selectedBy

When verbose mode is enabled, name of the profile selector rule that chooses the profile to use for the transaction. If no profile selector exists, the value is Default Active Profile.

casePriority

You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) – 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order.

velocityInfoCode

List of information codes triggered by the order.

These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules.

Cybersource Token and Authorization Request (paySubscriptionCreate and ccAuthService) XML Message

The Cybersource ccAuthService Request XML message is used to authorize a credit card payment and to also request a token in the same transaction.

Sample transaction: See Cybersource Token and Authorization (paySubscriptionCreate and ccAuthService) Transaction: Sample Messages.

Special characters: Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. Order Management System replaces the following special characters with the text strings listed below.

Special Character

Description

Replacement Text String

single quote

&apos;

"

double quote

&quot;

>

greater than

&gt;

<

less than

&lt;

&

ampersand

&amp;

Order Management System also removes any non-standard keyboard characters from the XML message before sending it to Cybersource.

The elements and attributes of the ccAuthService Request XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

requestMessage

merchantID

The account number assigned by Cybersource to identify transmissions. From the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

merchantReferenceCode

The company code + order number + order payment method sequence number.

From the Company, Order # and OPM Seq # fields in the Order Payment Method table.

billTo

firstName

The bill to customer’s first name. From the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

lastName

The bill to customer’s last name. From the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold to table.

Note: If a last name is not passed, Cybersource fails the transaction.

street1

The street address on the bill to customer’s address, followed by the text APT and the apartment or suite number defined for the bill to customer’s address. For example: 123 MAIN ST APT 2B. From the:

Street address and APT Code in the Customer Bill To table, or

NAM Street address and Apartment in the Customer Sold To table.

street2

The second address line on the bill to customer’s address. From the:

Address line 2 field in the Customer Bill To table, or

NAM Address line 2 in the Customer Sold To table.

city

The city on the bill to address. From the:

City field in the Customer Bill To table, or

City field in the Customer Sold To table.

state

The state code on the bill to customer’s address. From the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

postalCode

The zip code on the bill to customer’s address.

If the country code is US, the 9-digit zip code is in 99999-9999 format.

If the country code is CA, the 6-digit zip code is in A1B 2C3.

If the country code is JP, the 7-digit zip code is in 999-9999 format.

If the country code is GB, the 6-digit zip code is in AB12CD format.

From the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

The country code on the bill to customer’s address. The system uses the Work with Authorization Service Country Screen to cross-reference the Order Management System country code in the Customer Bill To table or Customer Sold To table to the Cybersource country code.

From the Auth Service Country field in the Auth Service Country table.

email

The bill to customer’s email address.

If an email address is not defined for the bill to customer, null@Cybersource.com defaults.

From the CST email address field in the Customer Sold To table.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

From the ASC Currency code field in the Auth Service Currency table.

grandTotalAmount

The amount to authorize, including decimals, in the currency defined on the order.

Online transactions: From the OLA auth amt field in the Online Authorization table.

Batch transactions: From the Auth $ amt field in the CC Authorization Trans table.

card

accountNumber

The card number to authorized and replace with a token.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

From the OPM credit card number field in the Order Payment Method table.

expirationMonth

The month when the card expires, in MM format.

From the first 2 positions of the OPM expiration date field in the Order Payment Method table.

expirationYear

The year when the card expires, in YYYY format.

From the last 2 positions of the OPM expiration date field in the Order Payment Method table.

cardType

The vendor paytype code defined for the credit card pay type. This is the code Cybersource uses to identify the method of payment.

From the CPC vendor paytype/code field in the CC Paytype Cross Ref table.

cvIndicator

The card identification indictor defined for the card, indicating if a CID number has been defined. Valid values:

1 = CID number is present on card.

2 = CID number is present on card, but is illegible.

9 = CID number is not present on card.

Included only for online transactions.

cvNumber

The card identification number defined for the card.

Visa, MasterCard, Discover: The card identification number is a 3 digit number.

American Express: The card identification number is a 4 digit number.

Note: The card identification number is available only for online transactions; once an order is accepted, the system removes the card identification number from the order.

issueNumber

The card issue number defined for the card being processed.

From the OPM card issue # field in the Order Payment Method table.

startMonth

The start month defined for the card being processed, in MM format.

From the first 2 positions of the Start date field in the Order Payment Method table.

startYear

The start year defined for the card being processed, in YYYY format.

From the last 2 positions of the Start date field in the Order Payment Method table.

ccAuthService_run

true defaults.

recurringSubscriptionInfo

frequency

on-demand defaults.

decisionManager

enabled

false defaults.

ccAuthService

ccAuthService run

true defaults.

commerceIndicator

internet defaults if the E-Commerce indicator (Future use status 1) field in the Order Header table is set to I or the order type for the order matches the order type defined in the E-Commerce Order Type (G42) system control value; otherwise, moto defaults.

cavv

A code received from an authentication service, such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating whether the card authentication password the cardholder provided was approved for the credit card. See Credit Card Authentication Service for more information.

From the Authentication value field in the Order Payment Method table.

eciRaw

A code received from an authentication service, such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating whether the card authentication password the cardholder provided was approved for the credit card. See Credit Card Authentication Service for more information.

From the Authentication value field in the Order Payment Method table.

paySubscriptionCreate

Service_run

true defaults.

businessRules

ignoreAVSResult

true defaults.

ignoreCVResult

true defaults.

Cybersource Token and Authorization Response (paySubscriptionCreate and ccAuthService) XML Message

The Cybersource ccAuthService Response XML message contains the response from Cybersource for the Cybersource Token and Authorization Request (paySubscriptionCreate and ccAuthService) XML Message.

Sample transaction: See Cybersource Token and Authorization (paySubscriptionCreate and ccAuthService) Transaction: Sample Messages.

The elements and attributes of the ccAuthService Response XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

replyMessage

 

merchantReferenceCode

The order number + order payment method sequence number, used to match the response to the correct request.

Corresponds to the Order # and OPM Seq # fields in the Order Payment Method table.

requestID

The unique transaction ID assigned by Cybersource for the transaction.

Updates the Transaction ID field in the Authorization History table.

decision

ACCEPT indicates Cybersource approved the transaction.

ERROR indicates an error occurred while Cybersource was processing the transaction.

REJECT indicates Cybersource rejected the transaction.

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

Corresponds to the Response Code field in the CC Vendor Response table and updates the AUH vendor response field in the Authorization History table.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestToken

The token assigned to the credit card associated with the authorization transaction, encrypted.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

Corresponds to the ASC Currency code field in the Auth Service Currency table.

ccAuthReply

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

Corresponds to the Response Code field in the CC Vendor Response table.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

amount

The amount authorized by Cybersource, including decimals, in the currency defined on the order.

Updates the AUH amount authorized field in the Authorization History table.

authorizationCode

The authorization number provided by Cybersource.

Updates the AUH auth # field in the Authorization History table.

avsCode

The address verification response for the credit card.

Updates the AUH AVS response field in the Authorization History table.

avsCodeRaw

The address verification response for the credit card, from the processor.

cvCode

The card identification response for the credit card.

Updates the AUH Vendor Response 2 field in the Authorization History table.

authorizedDateTime

The date and time the credit card was authorized, in YYYY-MM-DDTHH:MM:SSZ format.

Updates the AUH auth date field in the Authorization History table.

processorResponse

The response code from the bank. Informational only.

reconciliationID

A code assigned by Cybersource as a reference number for the transaction.

paySubscriptionCreateReply

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

Corresponds to the Response Code field in the CC Vendor Response table.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

subscriptionID

The token assigned to the credit card payment.

Cybersource uses this code to reference the customer profile information in the Cybersource database.

Updates the OPM credit card number field in the Order Payment Method table.

Cybersource Debit Deposit Request (ccCaptureService) XML Message

The Cybersource Debit Deposit Request XML message is used to deposit a debit invoice whose amount is equal to or less than the authorization amount.

Sample transaction: See Cybersource Debit Deposit (ccCaptureService) Transaction: Sample Messages.

Special characters: Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. Order Management System replaces the following special characters with the text strings listed below.

Special Character

Description

Replacement Text String

single quote

&apos;

"

double quote

&quot;

>

greater than

&gt;

<

less than

&lt;

&

ampersand

&amp;

Order Management System also removes any non-standard keyboard characters from the XML message before sending it to Cybersource.

The elements and attributes of the Cybersource Debit Deposit Request (ccCaptureService) XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

requestMessage

merchantID

The account number assigned by Cybersource to identify transmissions. From the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

merchantReferenceCode

The company code + order number + order payment method sequence number.

From the Company, Order # and OPM Seq # fields in the Order Payment Method table.

invoiceHeader

userPO

The purchase order number associated with the deposit. From the Purchase order # field in the Order Ship To table.

If a purchase order is not defined, the system defaults the Order Management System order number. From the Order # field in the Order Payment Method table.

Included only if the transaction qualifies for level II or III discounting and the payment method is Visa, American Express, or MasterCard; see Level II and III Discounting.

billTo

Included only if you do not use credit card tokenization or if the credit card payment has not yet been replaced with a token from Cybersource.

firstName

The bill to customer’s first name. From the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

lastName

The bill to customer’s last name. From the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold to table.

Note: If a last name is not passed, Cybersource fails the transaction.

street1

The street address on the bill to customer’s address. From the:

Street address in the Customer Bill To table, or

NAM Street address in the Customer Sold To table.

street2

The second address line on the bill to customer’s address, followed by the text APT and the apartment or suite number defined for the bill to customer’s address. For example: GARDEN TERRACE APT 2B. From the:

Address line 2 and APT Code in the Customer Bill To table, or

NAM Address line 2 and Apartment in the Customer Sold To table.

city

The city on the bill to address. From the:

City field in the Customer Bill To table, or

City field in the Customer Sold To table.

state

The state code on the bill to customer’s address. From the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

postalCode

The zip code on the bill to customer’s address.

If the country code is US, the 9-digit zip code is in 99999-9999 format.

If the country code is CA, the 6-digit zip code is in A1B 2C3.

If the country code is JP, the 7-digit zip code is in 999-9999 format.

If the country code is GB, the 6-digit zip code is in AB12CD format.

From the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

The country code on the bill to customer’s address. The system uses the Work with Authorization Service Country Screen to cross-reference the Order Management System country code in the Customer Bill To table or Customer Sold To table to the Cybersource country code.

From the Auth Service Country field in the Auth Service Country table.

email

The bill to customer’s email address.

If an email address is not defined for the bill to customer, null@Cybersource.com defaults.

From the CST email address field in the Customer Sold To table.

item

id

0 defaults.

unitPrice

The unit price of the item, including decimals, in the currency defined on the order, minus any hidden tax included in the item price.

From the IDT Price field in the Invoice Detail table.

Included only if the transaction qualifies for level II or III discounting and the payment is a method other than Discover or JCB; see Level II and III Discounting.

quantity

The quantity of the item shipped.

From the IDT Qty shipped field in the Invoice Detail table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productCode

The item number on the deposit.

From the ITM Number field in the Item table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productName

A description of the item.

From the Description field in the Item table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productSKU

The SKU of the item on the deposit.

From the SKU Code field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

taxAmount

The tax amount for the item, including decimals, in the currency defined on the order, including any hidden tax included in the item price.

From the Tax field in the Invoice Detail table.

Included only if the transaction qualifies for level II discounting and the payment method is Visa, American Express, or MasterCard, or the transaction qualifies for level III discounting and the payment method is Visa or MasterCard. See Level II and III Discounting.

unitOfMeasure

The unit of measure defined for the item.

From the Unit of measure field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

taxRate

The tax rate defined for the item. The system uses this calculation to determine the tax rate:

taxAmount / unitPrice = taxRate

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

totalAmount

The total price of the item, including decimals, in the currency defined on the order. The system uses this calculation to determine the total amount:

item_#_quantity x the item_#_unitPrice = item_#_totalAmount

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

discountAmount

The discount amount applied to the item, including decimals, in the currency defined on the order.

From the IDT Discount amount field in the Invoice Detail table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

commodityCode

The commodity code defined for the item.

From the SKU Commodity Code field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

grossNetIndicator

Y defaults if a value is passed in the vatTaxAmount tag; otherwise, N defaults.

Included only if the transaction qualifies for level III discounting and the payment method is MasterCard; see Level II and III Discounting.

discountIndicator

Y defaults if an amount greater than 0 exists in the discountAmount tag; otherwise, N defaults.

Included only if the transaction qualifies for level III discounting and the payment method is MasterCard; see Level II and III Discounting.

purchaseTotals

currency

The currency on the order.

The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

From the ASC Currency code field in the Auth Service Currency table.

discountAmount

The discount amount for the deposit, including decimals, in the currency defined on the order.

From the INS Discount amount filed in the Invoice Ship To table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

dutyAmount

The duty amount for the deposit, including decimals, in the currency defined on the order.

From the IDC Amount field in the Invoice Detail Charge table for IDC Type of Charge D.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

grandTotalAmount

The amount to deposit, including decimals, in the currency defined on the order.

From the Total $ amt field in the CC Deposit Transaction table.

freightAmount

The freight amount for the deposit, including decimals, in the currency defined on the order.

From the INS Freight field in the Invoice Ship To table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

otherTax

vatTaxAmount

The VAT tax amount defined for the item, including decimals, in the currency defined on the order.

From the IDC Amount field in the Invoice Detail Charge table for IDC Type of Charge V.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

vatTaxRate

The VAT percent defined for the ship to customer’s country.

From the CNT VAT percent in the Country table.

Included only if the transaction qualifies for level II discounting and the payment method is Visa; see Level II and III Discounting.

card

Included only if you do not use credit card tokenization or if the credit card payment has not yet been replaced with a token from Cybersource.

accountNumber

The card number to authorized and replace with a token.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

From the OPM credit card number field in the Order Payment Method table.

expirationMonth

The month when the card expires, in MM format.

From the first 2 positions of the OPM expiration date field in the Order Payment Method table.

expirationYear

The year when the card expires, in YYYY format.

From the last 2 positions of the OPM expiration date field in the Order Payment Method table.

cardType

The vendor paytype code defined for the credit card pay type. This is the code Cybersource uses to identify the method of payment.

From the CPC vendor paytype/code field in the CC Paytype Cross Ref table.

issueNumber

The card issue number defined for the card being processed.

From the OPM card issue # field in the Order Payment Method table.

startMonth

The start month defined for the card being processed, in MM format.

From the first 2 positions of the Start date field in the Order Payment Method table.

startYear

The start year defined for the card being processed, in YYYY format.

From the last 2 positions of the Start date field in the Order Payment Method table.

ccCaptureService

ccCaptureService run

true defaults.

authRequestID

The transaction ID for the authorization associated with the deposit.

From the Transaction ID field in the Authorization History table.

purchasingLevel

3 defaults if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; otherwise, this value is not passed. See Level II and III Discounting.

paySubscriptionCreate

Service_run

true defaults if a token is requested in the deposit transaction.

Cybersource Debit Deposit Response (ccCaptureService) XML Message

The Cybersource Debit Deposit Response (ccCaptureService) XML message contains the response from Cybersource for the Cybersource Debit Deposit Request (ccCaptureService) XML Message.

Sample transaction: See Cybersource Debit Deposit (ccCaptureService) Transaction: Sample Messages.

The elements and attributes of the Cybersource Debit Deposit Response (ccCaptureService) XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

replyMessage

merchantReferenceCode

The company code + order number + order payment method sequence number, to match the response to the correct deposit.

Updates the Company, Order # and OPM Seq # fields in the CC Deposit History table.

requestID

The unique transaction ID assigned by Cybersource for the transaction.

decision

ACCEPT indicates Cybersource approved the transaction.

ERROR indicates an error occurred while Cybersource was processing the transaction.

REJECT indicates Cybersource rejected the transaction.

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table and updates the Response code field in the CC Deposit History table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestToken

The token assigned to the credit card associated with the deposit transaction, encrypted.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

Corresponds to the ASC Currency code field in the Auth Service Currency table.

ccCaptureReply

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table. Updates the Response code field in the CC Deposit History table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestDateTime

The date and time the deposit was authorized by Cybersource, in YYYY-MM-DDTHH:MM:SSZ format. Order Management System translates this date format to CYYMMDD format.

Updates the Deposit date field in the CC Deposit History table.

amount

The amount deposited, including decimals, in the currency defined on the order.

Updates the Deposit Amount field in the CC Deposit History table.

reconciliationID

A code assigned by Cybersource as a reference number for the transaction.

purchasingLevel3

Enabled

Y defaults if the transaction qualifies for level II discounting; otherwise, this value is not passed.

Cybersource Credit Deposit Request (ccCreditService) XML Message

The Cybersource Credit Deposit Request XML message is used to deposit a credit invoice.

Sample transaction: See Cybersource Credit Deposit (ccCreditService) Transaction: Sample Messages.

Special characters: Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. Order Management System replaces the following special characters with the text strings listed below.

Special Character

Description

Replacement Text String

single quote

&apos;

"

double quote

&quot;

>

greater than

&gt;

<

less than

&lt;

&

ampersand

&amp;

Order Management System also removes any non-standard keyboard characters from the XML message before sending it to Cybersource.

The elements and attributes of the ccCreditService Request XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

requestMessage

merchantID

The account number assigned by Cybersource to identify transmissions. From the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

merchantReferenceCode

The company code + order number + order payment method sequence number.

From the Company, Order # and OPM Seq # fields in the Order Payment Method table.

invoiceHeader

userPO

The purchase order number associated with the deposit.

From the Purchase order # field in the Order Ship To table.

If a purchase order is not defined, the system defaults the Order Management System order number. From the Order # field in the Order Payment Method table.

Included only if the transaction qualifies for level II or III discounting and the payment method is Visa, American Express, or MasterCard; see Level II and III Discounting.

billTo

firstName

The bill to customer’s first name. From the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

lastName

The bill to customer’s last name. From the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold to table.

Note: If a last name is not passed, Cybersource fails the transaction.

street1

The street address on the bill to customer’s address. From the:

Street address in the Customer Bill To table, or

NAM Street address in the Customer Sold To table.

street2

The second address line on the bill to customer’s address, followed by the text APT and the apartment or suite number defined for the bill to customer’s address. For example: GARDEN TERRACE APT 2B. From the:

Address line 2 and APT Code in the Customer Bill To table, or

NAM Address line 2 and Apartment in the Customer Sold To table.

city

The city on the bill to address. From the:

City field in the Customer Bill To table, or

City field in the Customer Sold To table.

state

The state code on the bill to customer’s address. From the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

postalCode

The zip code on the bill to customer’s address.

If the country code is US, the 9-digit zip code is in 99999-9999 format.

If the country code is CA, the 6-digit zip code is in A1B 2C3.

If the country code is JP, the 7-digit zip code is in 999-9999 format.

If the country code is GB, the 6-digit zip code is in AB12CD format.

From the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

The country code on the bill to customer’s address. The system uses the Work with Authorization Service Country Screen to cross-reference the Order Management System country code in the Customer Bill To table or Customer Sold To table to the Cybersource country code.

From the Auth Service Country field in the Auth Service Country table.

email

The bill to customer’s email address.

If an email address is not defined for the bill to customer, null@Cybersource.com defaults.

From the CST email address field in the Customer Sold To table.

item

id

0 defaults.

unitPrice

The unit price of the item, including decimals, in the currency defined on the order, minus any hidden tax included in the item price.

From the IDT Price field in the Invoice Detail table.

Included only if the transaction qualifies for level II or III discounting and the payment is a method other than Discover or JCB; see Level II and III Discounting.

quantity

The quantity of the item shipped.

From the IDT Qty shipped field in the Invoice Detail table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productCode

The item number on the deposit.

From the ITM Number field in the Item table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productName

A description of the item.

From the Description field in the Item table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productSKU

The SKU of the item on the deposit.

From the SKU Code field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

taxAmount

The tax amount for the item, including decimals, in the currency defined on the order, including any hidden tax included in the item price.

Included only if the transaction qualifies for level II discounting and the payment method is Visa, American Express, or MasterCard, or the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

unitOfMeasure

The unit of measure defined for the item.

From the Unit of measure field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

taxRate

The tax rate defined for the item. The system uses this calculation to determine the tax rate:

taxAmount / unitPrice = taxRate

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

totalAmount

The total price of the item, including decimals, in the currency defined on the order. The system uses this calculation to determine the total amount:

item_#_quantity x the item_#_unitPrice = item_#_totalAmount

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

discountAmount

The discount amount applied to the item, including decimals, in the currency defined on the order.

From the IDT Discount amount field in the Invoice Detail table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

commodityCode

The commodity code defined for the item.

From the SKU Commodity Code field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

From the ASC Currency code field in the Auth Service Currency table.

discountAmount

The discount amount for the deposit, including decimals, in the currency defined on the order.

From the INS Discount amount filed in the Invoice Ship To table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

dutyAmount

The duty amount for the deposit, including decimals, in the currency defined on the order.

From the IDC Amount field in the Invoice Detail Charge table for IDC Type of Charge D.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

grandTotalAmount

The amount to deposit, including decimals, in the currency defined on the order.

From the Total $ amt field in the CC Deposit Transaction table.

freightAmount

The freight amount for the deposit, including decimals, in the currency defined on the order.

From the INS Freight field in the Invoice Ship To table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

otherTax

vatTaxAmount

The VAT tax amount defined for the item, including decimals, in the currency defined on the order.

From the IDC Amount field in the Invoice Detail Charge table for IDC Type of Charge V.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

vatTaxRate

The VAT percent defined for the ship to customer’s country.

From the CNT VAT percent in the Country table.

Included only if the transaction qualifies for level II discounting and the payment method is Visa; see Level II and III Discounting.

recurringSubscriptionInfo

Included only if a token is passed.

subscriptionID

The token for the credit card payment.

From the OPM credit card number field in the Order Payment Method table.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

frequency

on-demand defaults.

ccCreditService

 

ccCreditService run

true defaults.

purchasingLevel

3 defaults if the transaction qualifies for level II discounting and the payment method is Visa or MasterCard; otherwise, this value is not passed.

Cybersource Credit Deposit Response (ccCreditService) XML Message

The Cybersource Credit Deposit Response (ccCreditService) XML message contains the response from Cybersource for the Cybersource Credit Deposit Request (ccCreditService) XML Message.

Sample transaction: See Cybersource Credit Deposit (ccCreditService) Transaction: Sample Messages.

The elements and attributes of the Cybersource Credit Deposit Response (ccCreditService) XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

replyMessage

merchantReferenceCode

The company code + order number + order payment method sequence number, to match the response to the correct deposit.

Updates the Company, Order # and OPM Seq # fields in the CC Deposit History table.

requestID

The unique transaction ID assigned by Cybersource for the transaction.

decision

ACCEPT indicates Cybersource approved the transaction.

ERROR indicates an error occurred while Cybersource was processing the transaction.

REJECT indicates Cybersource rejected the transaction.

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table and updates the Response code field in the CC Deposit History table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestToken

The token assigned to the credit card associated with the deposit transaction, encrypted.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

Corresponds to the ASC Currency code field in the Auth Service Currency table.

ccCreditReply

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table. Updates the Response code field in the CC Deposit History table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestDateTime

The date and time the deposit was authorized by Cybersource, in YYYY-MM-DDTHH:MM:SSZ format. Order Management System translates this date format to CYYMMDD format.

Updates the Deposit date field in the CC Deposit History table.

amount

The amount deposited, including decimals, in the currency defined on the order.

Updates the Deposit Amount field in the CC Deposit History table.

reconciliationID

A code assigned by Cybersource as a reference number for the transaction.

purchasingLevel3

Enabled

Y defaults if the transaction qualifies for level II discounting; otherwise, this value is not passed.

ownerMerchantID

The account number assigned by Cybersource to identify transmissions. From the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

Cybersource Authorization and Deposit Request (ccAuthService and ccCaptureService) XML Message

The Cybersource Authorization and Deposit Request XML message is used to authorize and deposit a debit invoice. The system generates this message when:

• the deposit amount is greater than the authorization amount.

• the authorization has expired.

• the deposit is for a deferred payment plan.

• the deposit is for an installment payment plan after the initial deposit for the plan.

Sample transaction: See Cybersource Authorization and Deposit (ccAuthService and ccCaptureService) Transaction: Sample Messages.

Special characters: Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. Order Management System replaces the following special characters with the text strings listed below.

Special Character

Description

Replacement Text String

single quote

&apos;

"

double quote

&quot;

>

greater than

&gt;

<

less than

&lt;

&

ampersand

&amp;

Order Management System also removes any non-standard keyboard characters from the XML message before sending it to Cybersource.

The elements and attributes of the Authorization and Capture Request XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

requestMessage

merchantID

The account number assigned by Cybersource to identify transmissions. From the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

merchantReferenceCode

The company code + order number + order payment method sequence number.

From the Company, Order # and OPM Seq # fields in the Order Payment Method table.

invoiceHeader

userPO

The purchase order number associated with the deposit.

From the Purchase order # field in the Order Ship To table.

If a purchase order is not defined, the system defaults the Order Management System order number. From the Order # field in the Order Payment Method table.

Included only if the transaction qualifies for level II or III discounting and the payment method is Visa, American Express, or MasterCard; see Level II and III Discounting.

billTo

Included only if you do not use credit card tokenization or if the credit card payment has not yet been replaced with a token from Cybersource.

firstName

The bill to customer’s first name. From the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

lastName

The bill to customer’s last name. From the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold to table.

Note: If a last name is not passed, Cybersource fails the transaction.

street1

The street address on the bill to customer’s address. From the:

Street address in the Customer Bill To table, or

NAM Street address in the Customer Sold To table.

street2

The second address line on the bill to customer’s address, followed by the text APT and the apartment or suite number defined for the bill to customer’s address. For example: TERRACE GARDEN APT 2B. From the:

Address line 2 and APT Code in the Customer Bill To table, or

NAM Address line 2 and Apartment in the Customer Sold To table.

city

The city on the bill to address. From the:

City field in the Customer Bill To table, or

City field in the Customer Sold To table.

state

The state code on the bill to customer’s address. From the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

postalCode

The zip code on the bill to customer’s address.

If the country code is US, the 9-digit zip code is in 99999-9999 format.

If the country code is CA, the 6-digit zip code is in A1B 2C3.

If the country code is JP, the 7-digit zip code is in 999-9999 format.

If the country code is GB, the 6-digit zip code is in AB12CD format.

From the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

The country code on the bill to customer’s address. The system uses the Work with Authorization Service Country Screen to cross-reference the Order Management System country code in the Customer Bill To table or Customer Sold To table to the Cybersource country code.

From the Auth Service Country field in the Auth Service Country table.

email

The bill to customer’s email address.

If an email address is not defined for the bill to customer, null@Cybersource.com defaults.

From the CST email address field in the Customer Sold To table.

item

id

0 defaults.

unitPrice

The unit price of the item, including decimals, in the currency defined on the order, minus any hidden tax included in the item price.

From the IDT Price field in the Invoice Detail table.

Included only if the transaction qualifies for level II or III discounting and the payment is a method other than Discover or JCB; see Level II and III Discounting.

quantity

The quantity of the item shipped.

From the IDT Qty shipped field in the Invoice Detail table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productCode

The item number on the deposit.

From the ITM Number field in the Item table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productName

A description of the item.

From the Description field in the Item table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

productSKU

The SKU of the item on the deposit.

From the SKU Code field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

taxAmount

The tax amount for the item, including decimals, in the currency defined on the order, including any hidden tax included in the item price.

Included only if the transaction qualifies for level II discounting and the payment method is Visa, American Express, or MasterCard, or the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

unitOfMeasure

The unit of measure defined for the item.

From the Unit of measure field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

taxRate

The tax rate defined for the item. The system uses this calculation to determine the tax rate:

taxAmount / unitPrice = taxRate

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

totalAmount

The total price of the item, including decimals, in the currency defined on the order. The system uses this calculation to determine the total amount:

item_#_quantity x the item_#_unitPrice = item_#_totalAmount

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

discountAmount

The discount amount applied to the item, including decimals, in the currency defined on the order.

From the IDT Discount amount field in the Invoice Detail table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

commodityCode

The commodity code defined for the item.

From the SKU Commodity Code field in the SKU table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

From the ASC Currency code field in the Auth Service Currency table.

discountAmount

The discount amount for the deposit, including decimals, in the currency defined on the order.

From the INS Discount amount filed in the Invoice Ship To table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

dutyAmount

The duty amount for the deposit, including decimals, in the currency defined on the order.

From the IDC Amount field in the Invoice Detail Charge table for IDC Type of Charge D.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

grandTotalAmount

The amount to deposit, including decimals, in the currency defined on the order.

From the Total $ amt field in the CC Deposit Transaction table.

freightAmount

The freight amount for the deposit, including decimals, in the currency defined on the order.

From the INS Freight field in the Invoice Ship To table.

Included only if the transaction qualifies for level III discounting and the payment method is Visa or MasterCard; see Level II and III Discounting.

otherTax

vatTaxAmount

The VAT tax amount defined for the item, including decimals, in the currency defined on the order.

From the IDC Amount field in the Invoice Detail Charge table for IDC Type of Charge V.

Included only if the transaction qualifies for level III discounting and the payment method is Visa; see Level II and III Discounting.

vatTaxRate

The VAT percent defined for the ship to customer’s country.

From the CNT VAT percent in the Country table.

Included only if the transaction qualifies for level II discounting and the payment method is Visa; see Level II and III Discounting.

card

Included only if you do not use credit card tokenization or if the credit card payment has not yet been replaced with a token from Cybersource.

accountNumber

The card number to authorized and replace with a token.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

From the OPM credit card number field in the Order Payment Method table.

expirationMonth

The month when the card expires, in MM format.

From the first 2 positions of the OPM expiration date field in the Order Payment Method table.

expirationYear

The year when the card expires, in YYYY format.

From the last 2 positions of the OPM expiration date field in the Order Payment Method table.

cardType

The vendor paytype code defined for the credit card pay type. This is the code Cybersource uses to identify the method of payment.

From the CPC vendor paytype/code field in the CC Paytype Cross Ref table.

issueNumber

The card issue number defined for the card being processed.

From the OPM card issue # field in the Order Payment Method table.

startMonth

The start month defined for the card being processed, in MM format.

From the first 2 positions of the Start date field in the Order Payment Method table.

startYear

The start year defined for the card being processed, in YYYY format.

From the last 2 positions of the Start date field in the Order Payment Method table.

recurringSubscriptionInfo

subscriptionID

The token for the credit card payment.

From the OPM credit card number field in the Order Payment Method table.

If you use credit card encryption, the system decrypts the credit card number before sending it to Cybersource; see the Data Security and Encryption Guide.

frequency

on-demand defaults.

decisionManager

enabled

false defaults.

ccAuthService

 

ccAuthService run

true defaults.

commerceIndicator

internet defaults if the E-Commerce indicator (Future use status 1) field in the Order Header table is set to I or the order type for the order matches the order type defined in the E-Commerce Order Type (G42) system control value; otherwise, moto defaults.

cavv

A code received from an authentication service, such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating whether the card authentication password the cardholder provided was approved for the credit card. See Credit Card Authentication Service for more information.

From the Authentication value field in the Order Payment Method table.

eciRaw

A code received from an authentication service, such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating whether the card authentication password the cardholder provided was approved for the credit card. See Credit Card Authentication Service for more information.

From the Authentication value field in the Order Payment Method table.

businessRules

ignoreAVSResult

true defaults.

ignoreCVResult

true defaults.

ccCaptureService

 

ccCaptureService run

true defaults.

authRequestID

The transaction ID for the authorization associated with the deposit.

From the Transaction ID field in the Authorization History table.

purchasingLevel

3 defaults if the transaction qualifies for level II discounting and the payment method is Visa or MasterCard; otherwise, this value is not passed.

paySubscriptionCreate

Service_run

true defaults if a token is requested in the deposit transaction.

Cybersource Authorization and Deposit Response (ccAuthService and ccCaptureService) XML Message

The Cybersource Authorization and Capture Response XML message contains the response from Cybersource for the Cybersource Authorization and Deposit Request (ccAuthService and ccCaptureService) XML Message.

Sample transaction: See Cybersource Authorization and Deposit (ccAuthService and ccCaptureService) Transaction: Sample Messages.

The elements and attributes of the Authorization and Capture Response XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

replyMessage

 

merchantReferenceCode

The company code + order number + order payment method sequence number, to match the response to the correct deposit.

Updates the Company, Order # and OPM Seq # fields in the CC Deposit History table.

requestID

The unique transaction ID assigned by Cybersource for the transaction.

decision

ACCEPT indicates Cybersource approved the transaction.

ERROR indicates an error occurred while Cybersource was processing the transaction.

REJECT indicates Cybersource rejected the transaction.

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table and updates the Response code field in the CC Deposit History table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestToken

The token assigned to the credit card associated with the deposit transaction, encrypted.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

Corresponds to the ASC Currency code field in the Auth Service Currency table.

ccAuthReply

 

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

amount

The amount authorized by Cybersource, including decimals, in the currency defined on the order.

Updates the AUH amount authorized field in the Authorization History table.

authorizationCode

The authorization number provided by Cybersource.

Updates the AUH auth # field in the Authorization History table.

avsCode

The address verification response for the credit card.

Updates the AUH AVS response field in the Authorization History table.

avsCodeRaw

The address verification response for the credit card, from the processor.

authorizedDateTime

The date and time the credit card was authorized, in YYYY-MM-DDTHH:MM:SSZ format.

Updates the AUH auth date field in the Authorization History table.

processorResponse

The response code from the bank. Informational only.

reconciliationID

A code assigned by Cybersource as a reference number for the transaction.

ownerMerchantID

The account number assigned by Cybersource to identify transmissions. Corresponds to the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

ccCaptureReply

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table. Updates the Response code field in the CC Deposit History table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestDateTime

The date and time the deposit was authorized by Cybersource, in YYYY-MM-DDTHH:MM:SSZ format. Order Management System translates this date format to CYYMMDD format.

Updates the Deposit date field in the CC Deposit History table.

amount

The amount deposited, including decimals, in the currency defined on the order.

Updates the Deposit Amount field in the CC Deposit History table.

reconciliationID

A code assigned by Cybersource as a reference number for the transaction.

purchasingLevel3

Enabled

Y defaults if the transaction qualifies for level II discounting; otherwise, this value is not passed.

Cybersource Authorization Reversal Request (ccAuthReversalService) XML Message

The Cybersource Authorization Reversal Request (ccAuthReversalService) XML message is used to reverse an authorization for a credit card payment. The system generates this message when the deposit amount is greater than the authorization amount and it has not been more than 72 hours since the authorization was obtained.

Sample transaction: See Cybersource Authorization Reversal (ccAuthReversalService) Transaction: Sample Messages.

Special characters: Certain special characters cannot be passed in an attribute of an XML message except through the use of replacement text strings. Order Management System replaces the following special characters with the text strings listed below.

Special Character

Description

Replacement Text String

single quote

&apos;

"

double quote

&quot;

>

greater than

&gt;

<

less than

&lt;

&

ampersand

&amp;

Order Management System also removes any non-standard keyboard characters from the XML message before sending it to Cybersource.

The elements and attributes of the Authorization Reversal Request (ccAuthReversalService) XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

requestMessage

merchantID

The account number assigned by Cybersource to identify transmissions. From the:

Merchant # field in the CC Paytype Cross Ref table, or

Merchant ID field in the Merchant ID Override table, or

Merchant ID field in the Authorization Services table.

merchantReferenceCode

The company code + order number + order payment method sequence number.

From the Company + Order # and OPM Seq # fields in the Order Payment Method table.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

From the ASC Currency code field in the Auth Service Currency table.

grandTotalAmount

The amount to reverse, including decimals, in the currency defined on the order.

From the Amount authorized field in the Authorization History table.

ccAuthReversalService

 

ccAuthReversalService run

true defaults.

authRequestID

The transaction ID for the authorization associated with the deposit.

From the Transaction ID field in the Authorization History table.

Cybersource Authorization Reversal Response (ccAuthReversalService) XML Message

The Cybersource Authorization Reversal Response (ccAuthReversalService) XML message contains the response from Cybersource for the Cybersource Authorization Reversal Request (ccAuthReversalService) XML Message.

Sample transaction: See Cybersource Authorization and Deposit (ccAuthService and ccCaptureService) Transaction: Sample Messages.

The elements and attributes of the Authorization Reversal Response XML message that are used by Order Management System are described below. See the Cybersource Credit_Cards_SO_API.pdf document for more information on the additional values in this message.

Attribute Name

Comments

replyMessage

merchantReferenceCode

The company code + order number + order payment method sequence number, used to match the response to the correct request.

Corresponds to the Company, Order # and OPM Seq # fields in the Order Payment Method table.

requestID

The unique transaction ID assigned by Cybersource for the transaction.

decision

ACCEPT indicates Cybersource approved the transaction.

ERROR indicates an error occurred while Cybersource was processing the transaction.

REJECT indicates Cybersource rejected the transaction.

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table and its description updates the AHR response field in the Authorization History SVC Reversal table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

requestToken

The token assigned to the credit card associated with the authorization transaction, encrypted.

purchaseTotals

currency

The currency on the order. The system uses the Work with Authorization Service Currency Screen to cross-reference the Order Management System currency code to the Cybersource currency code.

Corresponds to the ASC Currency code field in the Auth Service Currency table.

ccAuthReversalReply

reasonCode

The reason the transaction was approved or rejected by Cybersource.

100 indicates the transaction was successful.

151 indicates the request was received by Cybersource but there was a server timeout. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

152 indicates the request was received by Cybersource but a service did not finish running in time. If you receive this reason, do not resend the request until you have reviewed the transaction status in the Cybersource Business Center. See the documentation for your Cybersource client (SDK) for information about how to handle retries in the case of system errors.

Corresponds to the Response Code field in the CC Vendor Response table.

Corresponds to the Response Code field in the CC Vendor Response table and its description updates the AHR response field in the Authorization History SVC Reversal table.

See Reason Codes for the Simple Order API in the Cybersource Credit_Cards_SO_API.pdf document for a complete list of valid reason codes.

amount

The amount reversed by Cybersource, including decimals, in the currency defined on the order.

Updates the AHR Reversal amount field in the Authorization History SVC Reversal table.

processorResponse

The response code from the bank. Informational only.

requestDateTime

The date and time the credit card reversal was authorized, in YYYY-MM-DDTHH:MM:SSZ format.

Updates the AHR creation date field in the Authorization History SVC Reversal table.

SO04_16CYB OROMS 17.0 2018 OTN