Authorization and Deposit XML Messages

Authorization Request XML Message (CWAuthorizationRequest)

Authorization Response XML Message (CWAuthorizationResponse)

Deposit Request XML Message (CWDepositRequest)

Deposit Response XML Message (CWDepositResponse)

Authorization Request XML Message (CWAuthorizationRequest)

 

The Authorization Request XML message is used to send the following information to the an external system when the Communication type field for the service bureau is Integration Layer:

• authorizations (online and batch) for credit cards, stored value cards transactions, and debit (Switch) cards

• register token for credit cards (see Credit Card Tokenization in the Data Security and Encryption Guide)

• stored value card activations (see Activating a Stored Value Card for additional information)

• stored value card balance inquiries (see Stored Value Card Balance Inquiry (MSVB) for additional information)

• stored value card authorization reversals (see Stored Value Card Authorization Reversal for additional information)

The Mode attribute in this message indicates if the request is in online format or batch format.

Online format: An Authorization Request message in online format sends one message to the service bureau for processing. This one message contains all of the information required to process an online transaction.

Batch format: An Authorization Request message in batch format sends multiple message types to the service bureau for processing. These messages contain the information required to process a batch of transactions.

Note: Order Management System does not currently support any base integration using an integration layer job and the Authorization Request XML Message (CWAuthorizationRequest). Please contact your Order Management System representative if you wish to create a custom integration using this message.

Attribute Name

Type

Length

Comments

Message

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes display in the Header, Detail, Summary, Footer, Send, and Receive type messages.

source

alpha

25

Identifies the source of the XML message. RDC indicates the message is from Order Management System.

target

alpha

25

Identifies the target of the message.

type

alpha

25

Identifies the type of information in the message.

CWAuthorizationRequest indicates the message contains a card authorization request.

resp_qmgr

alpha

48

Informational only.

resp_q

alpha

48

Informational only.

CWAuthorizationRequest

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes display in the Header, Detail, Summary, Footer, Send, and Receive type messages.

mode

alpha

10

Indicates the mode of communication.

Online indicates online format.

Batch indicates batch format.

type

alpha

10

Online format: This tag is not included in the Online message.

Batch format: Indicates the type of message in the batch.

Valid values:

Header

Detail

Summary

Footer

Send

Receive

Service

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes display in the Header, Detail, Summary, Footer, Send, and Receive type messages.

serviceID

alpha

3

Authorization service code.

This is the ASV Auth service code field in the Authorization Service table.

Merchant

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes display in the Header, Detail, Summary, Footer, Send, and Receive type messages.

companyID

numeric

3

The company from where the authorization request was sent.

This is the CMP Company field in the Authorization Service table.

merchantID

alpha

20

The account number assigned by the service bureau to identify transmissions.

The system uses the following hierarchy to determine the merchant ID number to send to the service bureau:

Merchant # from the CC Paytype Cross Ref table.

Merchant ID override from the Merchant ID Override table.

Merchant ID from the Authorization Service table.

merchantSubID

alpha

10

The sub code required to sign on to the service bureau.

This is the ASV Sub code field in the Authorization Service table.

merchantName

alpha

20

The name of the service bureau.

This is the ASV Charge description field in the Authorization Service table.

merchantDivision

numeric

5

The merchant division defined by the service bureau.

This is the ASE Merchant division field in the Authorization Service Ext table.

chargeDescription

alpha

20

The name of the service bureau.

This is the ASV Charge description field in the Authorization Service table.

receivingCode

alpha

10

A code that identifies your company to the service bureau.

This is the ASV Receiving code field in the Authorization Service table.

startupInfo

alpha

10

Startup text that identifies your company to the service bureau.

This is the ASV Start up info field in the Authorization Service table.

signon

alpha

10

A code required to sign on to the service bureau.

This is the ASV Signon field in the Authorization Service table.

password

alpha

10

A password required by the service bureau.

This is the ASV Password field in the Authorization Service table.

presentersID

alpha

10

A code required to sign on to the service bureau.

This is the ASV Presenter’s ID field in the Authorization Service table.

pidPassword

alpha

10

A password required to sign on to the service bureau.

This is the ASV PID password field in the Authorization Service table.

submittersID

alpha

10

A code required to sign on to the service bureau.

This is the ASV Submitter’s ID field in the Authorization Service table.

sidPassword

alpha

10

A password required to sign on the service bureau.

This is the ASV SID password field in the Authorization Service table.

industryFormatCode

alpha

5

A code that is assigned by the authorization service to identify your company type (DBA number).

This is the ASV Industry format code field in the Authorization Service table.

addressVerfication Flag

alpha

3

Indicates whether the service bureau performs address verification to verify the customer’s address and card number.

YES indicates the service bureau performs address verification. The system includes the bill to name and address in the authorization request.

NO indicates the service bureau does not perform address verification. The system does not include the bill to name and address in the authorization request.

This is the ASV Address verification field in the Authorization Service table.

JCLstatements

Not currently implemented.

count

numeric

2

From the Authorization Service JCL table.

JCLstatement

Not currently implemented.

id

alpha

2

From the JCL Seq # field and JCL Statement field in the Authorization Service JCL table.

AuthRequest

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes is included in the Detail type message.

companyID

alpha

3

The company from where the authorization request was sent.

Online format: From the Company field in the On Line Authorization table.

Batch format: From the CMP Company field in the CC Authorization Trans table.

createDate

numeric

8

The date (in MMDDYYYY format) the authorization request was sent to the service bureau.

orderType

alpha

8

Indicates the type of order, for example phone order or mail order, where the card requiring authorization is located.

Mail = Mail order.

Phone = Telephone order.

Internet = Web order.

Order Management System:

• Looks at the value in the Internet order field in the Order Header table. If this field is set to I, the order is a web order.

• Determines if the order type for the order matches the E-Commerce Order Type (G42) system control value. If the order type matches, the order is a web order.

• Looks at the Forecasting order category field in the Order Type table. If this value is 1, the order is a mail order. If this value is 2, the order is a phone order.

transactionType

alpha

10

Indicates if the transaction is a debit or credit.

Debit indicates card sale.

Credit indicates card credit/return.

storeLocation

alpha

10

This is a future-use value.

terminalID

numeric

15

Online format: From the OLA terminal # field in the On Line Authorization table; informational only.

Batch format: This attribute does not display for batch authorizations.

merchantReference

numeric

20

A unique number made up of the Order Management System company code + order number + order payment method sequence number + authorization sequence number.

For stored value card activations, this is the company code + order number; the payment method sequence number and authorization sequence number are zero-filled.

For stored value card balance inquiries, this is the company code + local workstation job number.

Online format: From the Company, Order#, OPM Seq #, OLA Seq # fields in the OnLine Authorization table.

Batch format: From the CMP Company, Order #, OPM Seq #, and AUH Seq # fields in the CC Authorization Trans table.

transactionSeq Number

numeric

15

Online format: The online authorization transaction sequence number.

From the OLA Trans seq # field in the OnLine Authorization table.

Batch format: 000000000000000 defaults for batch transactions.

orderID

numeric

8

The order number where the credit card payment method that requires authorization is located.

Online format: From the Order # field in the OnLine Authorization table.

Batch format: From the Order # field in the CC Authorization Trans table.

For stored value card activations, from the Order # field in the Stored Value Card table.

For stored value card reversals, from the Order # field in the Auth History SVC Reversal table.

paymentID

numeric

2

The order payment method sequence number for this credit card payment method on the order.

Online format: From the OPM Seq # field in the OnLine Authorization table.

Batch format: From the OPM Seq # field in the CC Authorization Trans table.

authID

numeric

3

The authorization sequence number for the credit card authorization request.

Online format: From the OLA Seq # field in the OnLine Authorization table.

Batch format: From the AUH Seq # field in the CC Authorization table.

payCategory

numeric

15

A description of the pay category associated with the credit card authorization request. Credit card displays, indicating the credit card is associated with the credit card pay category.

This is the description associated with the Pay category field defined for the credit card pay type in the Pay Type table.

vendorPayment Method

alpha

5

The vendor paytype code associated with the credit card authorization request; this is the code the authorization service uses to identify a method of payment.

SV displays for stored value card activations and reversals.

From the CPC vendor paytype/code field defined for the credit card pay type in the CC Paytype Cross Ref table.

cardType

alpha

10

Indicates the type of card being processed.

Valid values:

Credit card

Stored Value Card

Debit card

actionCode

alpha

10

Indicates the action to take against the card being processed.

Valid values:

Activation = Stored value card activation.

Balance = Stored value card balance inquiry.

Authorization = Credit card, debit card, or stored value card authorization.

Reversal = Stored value card authorization reversal.

ReqToken = Register token; see Credit Card Tokenization in the Data Security and Encryption Guide.

startDate

numeric

4

The start date of the debit card being processed, in MMYY format.

From the Start date field in the Order Payment Method table.

issueNumber

alpha

2

The card issue number of the debit card being processed.

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

ccAccountNumber

alpha

20

The card number for the credit card payment method requesting authorization.

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

If you use credit card encryption, the system decrypts the credit card number before sending it to the service bureau. See the Data Security and Encryption Guide for an overview.

If you use credit card tokenization, the setting of the tokenized tag defines whether the number in the ccAccountNumber tag is the actual credit card number or a token provided by an external tokenization service.

expirationDate

numeric

4

The date the card requesting authorization expires.

From the OPM expiration date field defined for the card in the Order Payment Method table.

authAmountText

numeric

10.2

The transaction amount, including decimals.

If the Use Alternate Currency Pricing (H89) system control value is selected and a currency code and conversion rate are defined in the Order Header Extended table, the alternate currency displays; otherwise, the local currency displays.

Note: Stored value cards are only allowed in US currency. In addition, stored value card balance inquiries, do not pass an amount.

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

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

authAmount

numeric

10

The transaction amount, with implied decimals.

If the Use Alternate Currency Pricing (H89) system control value is selected and a currency code and conversion rate are defined in the Order Header Extended table, the alternate currency displays; otherwise, the local currency displays.

Note: Stored value cards are only allowed in US currency. In addition, stored value card balance inquiries, do not pass an amount.

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

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

For stored value card activations, from the Issue amount field in the Stored Value Card table.

For stored value card reversals, from the Reversal amount field in the Auth History SVC Reversal table.

currencyCode

alpha

3

The currency code used by the service bureau to define a currency.

From the CUR currency code field in the Auth Service Currency table.

CIDNumber

numeric

4

Credit Cards

The card identification number defined for the card.

Visa: If the number is 3 positions, the number is left-justified and blank filled.

Diners Club: If the number is 3 positions, the system sends a leading space.

Discover: If the number is 3 positions, the number is left-justified and blank filled.

MasterCard: If the number is 3 positions, the number is left-justified and blank filled.

American Express: If the number is 3 positions, the system sends a leading zero.

From the OPM card security value field defined for the credit card payment method in the Order Payment Method table.

Note: The card identification number is only available for online authorizations; once an order is accepted, the system removes the card identification number from the order, even if the order has not received an approved online authorization.

Stored Value Cards

The ID number assigned to the stored value card. Included only if an ID number is assigned to the card and a CID number does not exist.

For activations, from the SVC ID # field in the Stored Value Card table.

For authorizations, from the OPM SVC ID Storage field defined for the stored value card payment in the Order Payment Method table.

CIDIndicator

alpha

1

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.

From the OPM card security presence field defined for the credit card payment method in the Order Payment Method table.

issuingBank

alpha

10

From the Issuing bank field defined for the payment method in the Order Payment Method table; this is a future-use value.

checkAccountNumber

alpha

20

From the OPM Checking account field defined for the payment method in the Order Payment Method table; this is a future-use value.

checkNumber

numeric

9

From the OPM Check number field defined for the payment method in the Order Payment Method table; this is a future-use value.

routingNumber

numeric

9

From the OPM Routing number field defined for the payment method in the Order Payment Method table; this is a future-use value.

ecommerceIndicator

alpha

3

Represents either:

• An electronic commerce indicator code, received from a service bureau such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating the level of security provided for a credit card transaction placed over the internet.

• A value indicating if the order was placed on a web storefront. Valid values are:

- YES = The order was placed over the web storefront.

- NO = The order was not placed over the web storefront.

From the Ecomm Indic field in the Order Payment Method table. If this value is blank, from the E-Commerce indicator (Future use status 1) field in the Order Header table.

authentication_value

alpha

40

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.

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

Note: The system includes the following bill to information only if the Address verification field for the authorization service is selected.

firstName

alpha

15

The first name of the bill to customer defined for the card requesting authorization.

This is the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

initial

alpha

1

The middle initial of the bill to customer defined for the card requesting authorization.

This is the:

Initial field in the Customer Bill To table, or

NAM Initial field in the Customer Sold To table.

lastName

alpha

25

The last name of the bill to customer defined for the card requesting authorization.

This is the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold To table.

companyName

alpha

30

The company name of the bill to customer defined for the card requesting authorization.

This is the:

Company name field in the Customer Bill To table, or

NAM Company name field in the Customer Sold To table.

suffix

alpha

3

The suffix of the bill to customer defined for the card requesting authorization.

This is the:

Suffix field in the Customer Bill To table, or

NAM Suffix field in the Customer Sold To table.

addressLine1

alpha

32

The street address of the bill to customer defined for the card requesting authorization.

This is the:

Street address field in the Customer Bill To table, or

NAM Street address field in the Customer Sold To table.

addressLine2

alpha

32

The second address line of the bill to customer defined for the card requesting authorization.

This is the:

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

NAM Address line 2 field in the Customer Sold To table.

addressLine3

alpha

32

The third address line of the bill to customer defined for the card requesting authorization.

This is the:

Address line 3 field in the Customer Bill To Extended table, or

Address line 3 field in the Customer Sold To Extended table.

addressLine4

alpha

32

The fourth address line of the bill to customer defined for the card requesting authorization.

This is the:

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

Address line 4 field in the Customer Sold To table.

apartment

alpha

10

The apartment for the address of the bill to customer defined for the card requesting authorization.

This is the:

Apartment field in the Customer Bill To table, or

NAM Apartment field in the Customer Sold To table.

city

alpha

25

The city for the address of the bill to customer defined for the card requesting authorization.

This is the:

City field in the Customer Bill To table, or

NAM City field in the Customer Sold To table.

state

alpha

2

The state for the address of the bill to customer defined for the card requesting authorization.

This is the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

zip

alpha

10

The zip code for the address of the bill to customer defined for the card requesting authorization.

This is the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

alpha

3

The country code for the address of the bill to customer defined for the card requesting authorization.

This is the:

RPR country field in the Customer Bill To table, or

RPR country field in the Customer Sold To table.

phoneType

alpha

12

Indicates the type of phone number (such as work or home) for the bill to customer defined for the card requesting authorization.

This is a description of the:

CB# Phone # type field in the Customer Bill To Phone # table, or

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

phoneNumber

alpha

14

The phone number of the bill to customer defined for the card requesting authorization.

This is the:

Phone field in the Customer Bill To Phone # table, or

Phone field in the Customer Sold To Phone # table.

shiptoFirstName

alpha

15

The first name of the ship to customer on the order.

This is the:

NAM First name field in the Order Ship To Address table, or

NAM First name field in the Customer Ship To table, or

NAM First name field in the Customer Sold To table.

shiptoInitial

alpha

1

The middle initial of the ship to customer on the order.

This is the:

NAM Initial field in the Order Ship To Address table, or

NAM Initial field in the Customer Ship To table, or

NAM Initial field in the Customer Sold To table.

shiptoLastName

alpha

25

The last name of the ship to customer on the order.

This is the:

NAM Last name field in the Order Ship To Address table, or

NAM Last name field in the Customer Ship To table, or

NAM Last name field in the Customer Sold To table.

shiptoCompanyName

alpha

30

The company of the ship to customer on the order.

This is the:

NAM Company name field in the Order Ship To Address table, or

NAM Company name field in the Customer Ship To table, or

NAM Company name field in the Customer Sold To table.

shiptoSuffix

alpha

3

The suffix code of the ship to customer on the order.

This is the:

NAM Suffix field in the Order Ship To Address table, or

NAM Suffix field in the Customer Ship To table, or

NAM Suffix field in the Customer Sold To table.

shiptoAddressLine1

alpha

32

The street address of the ship to customer on the order.

This is the:

NAM Street address field in the Order Ship To Address table, or

NAM Street address field in the Customer Ship To table, or

NAM Street address field in the Customer Sold To table.

shiptoAddressLine2

alpha

32

The second address line of the ship to customer on the order.

This is the:

NAM Address line 2 field in the Order Ship To Address table, or

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

NAM Address line 2 field in the Customer Sold To table.

shiptoAddressLine3

alpha

32

The third address line of the ship to customer on the order.

This is the:

Address line 3 field in the Order Ship To Address table, or

Address line 3 field in the Customer Ship To Extended table, or

Address line 3 field in the Customer Sold To Extended table.

shiptoAddressLine4

alpha

32

The fourth address line of the ship to customer on the order.

This is the:

Address line 4 field in the Order Ship To Address table, or

Address line 4 field in the Customer Ship To Extended table, or

Address line 4 field in the Customer Sold To Extended table.

shiptoApartment

alpha

10

The apartment for the address of the ship to customer on the order.

This is the:

NAM Apartment field in the Order Ship To Address table, or

NAM Apartment field in the Customer Ship To table, or

NAM Apartment field in the Customer Sold To table.

shiptoCity

alpha

25

The city for the address of the ship to customer on the order.

This is the:

NAM City field in the Order Ship To Address table, or

NAM City field in the Customer Ship To table, or

NAM City field in the Customer Sold To table.

shiptoState

alpha

2

The state for the address of the ship to customer on the order.

This is the:

NAM State field in the Order Ship To Address table, or

NAM State field in the Customer Ship To table, or

NAM State field in the Customer Sold To table.

shiptoZip

alpha

10

The postal code for the address of the ship to customer on the order.

This is the:

NAM Zip field in the Order Ship To Address table, or

NAM Zip field in the Customer Ship To table, or

NAM Zip field in the Customer Sold To table.

shiptoCountry

alpha

3

The country code for the address of the ship to customer on the order.

This is the:

RPR Country field in the Order Ship To Address table, or

RPR Country field in the Customer Ship To table, or

RPR Country field in the Customer Sold To table.

shiptoPhoneType

alpha

12

Indicates the type of phone number (such as work or home) for the ship to customer on the order.

This is a description of the:

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

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

shiptoPhoneNumber

alpha

14

The phone number of the ship to customer on the order.

This is the:

Phone field in the Customer Ship To Phone # table, or

Phone field in the Customer Sold To Phone # table.

shiptoEmail

alpha

50

The e-mail address of the ship to customer on the order.

This is the:

OSA Email address field in the Order Ship To Address table, or

CSH Email address field in the Customer Ship To table, or

Email field in the Customer Sold To table.

tcVersion

numeric

5

Not currently implemented.

dateOfBirth

numeric

8

Not currently implemented.

socialSecurityNbr

numeric

9

Not currently implemented.

shippingCost

numeric

8

Not currently implemented.

orderCreateTime

numeric

6

Not currently implemented.

itemClass

alpha

3

Not currently implemented.

lastOrderDate

numeric

8

Not currently implemented.

activeSinceDate

numeric

8

The date when the customer first placed an order, in MMDDYYYY format.

This is the COH active since date field in the Customer Sold To Ord Hist table.

email

alpha

50

The email address of the bill to customer defined for the credit card requesting authorization.

This is the CST email address field defined for the sold to customer on the order in the Customer Sold To table.

authCode

alpha

16

The authorization number used to authorize the card.

This is the Auth # field defined for the stored value card pay type on the order in the Authorization History table.

This field is populated only when performing a stored value card authorization reversal; see Stored Value Card Authorization Reversal.

tokenized

alpha

1

Defines whether the number in the ccAccountNumber is the actual credit card number or a token received from the authorization service during the credit card tokenization process. Valid values:

Y = The number in the ccAccountNumber is a token.

N = The number in the ccAccountNumber is the actual credit card number. The authorization service will attempt to replace the credit card number with a token and return the token in the Authorization Response XML Message (CWAuthorizationResponse).

From the Tokenized field in the Order Payment Method table.

The system includes the tokenized tag only if the pay type is eligible for tokenization. To be eligible for tokenization the Request token field for the authorization service defined for the pay type must be selected and the Pay category for the pay type must be Credit Card with the Card type set to C Credit Card.

Available in: 2.0 (Order Management System version 5.0).

BatchInfo

Online format: This element and its attributes is not included in the Online message.

Batch format: This element and its attributes is included in the Summary, Footer, Send, and Receive type messages.

fileType

alpha

4

Indicates the type of information in the request.

Valid values:

AUTH = Authorization request.

BILL = Deposit.

SVCA = Stored value card activation request.

SVCB = Stored value card balance inquiry request.

SVCR = Stored value card authorization reversal request.

merchantFileTrace

alpha

16

The next available number from the Batch Auth File Trace Number number assignment value.

Note: The Batch Auth File Trace Number cannot be greater than 3 positions.

createDate

numeric

8

The date (in MMDDYYYY format) the authorization request was sent to the service bureau.

debitAmount

numeric

11.2

The net sales amount for this batch of requests, with implied decimals.

Included for the summary and footer batch messages.

debitCount

numeric

9

The total count of sales records for this batch of authorization requests.

Included for the summary and footer batch messages.

creditAmount

numeric

11.2

The net refund amount for this batch of authorization requests, with implied decimals.

Included for the summary and footer batch messages.

creditCount

numeric

9

The total count of refund records for this batch of authorization requests.

Included for the summary and footer batch messages.

totalAmount

numeric

11.2

The total amount for this batch of authorization requests, with implied decimals.

Included for the summary and footer batch messages.

totalCount

numeric

9

The total count for this batch of authorization requests.

Included for the summary and footer batch messages.

testProductionFlag

alpha

4

Indicates whether the authorization request is processed in a live (production) environment or in a testing environment.

TEST = testing environment.

PROD = production environment.

This is the ASE Test mode field from the Authorization Service table.

Authorization Response XML Message (CWAuthorizationResponse)

 

For each Authorization Request Message sent to the service bureau, the service bureau sends an Authorization Response XML message to Order Management System.

The Mode attribute in this message indicates if the request is in online format or batch format.

Online format: An Authorization Response message in online format sends one message to Order Management System for processing. This one message contains all of the information required to process an online authorization response.

Batch format: An Authorization Response message in batch format sends multiple message types to Order Management System for processing. These messages contain the information required to process a batch of authorization responses. A separate detail type message is received for each authorization response in the batch.

Attribute Name

Type

Length

Comments

Message

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes is included in the send, receive, detail, and footer type messages.

source

alpha

25

Identifies the source of the XML message.

target

alpha

25

Identifies the target of the XML message. OROMS indicates the XML message is sent to Order Management System.

type

alpha

25

Identifies the type of information in the XML message.

CWAuthorizationResponse indicates the message contains a response from the service bureau.

CWAuthorizationResponse

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes is included in the send, receive, detail, and footer type messages.

mode

alpha

10

Indicates the mode of communication.

Batch = Batch authorizations response.

Online = Online authorizations response.

type

alpha

10

Indicates the type of message in the batch.

Online format: Detail displays.

Batch format: Valid values:

Header

Detail

Footer

Send

Receive

action

alpha

10

Indicates if the authorization was successful.

Complete

Error

Failed

Receiving

Response

Rejected

Sent

Returned

NotFound

AuthResponse

Online format: This element and its attributes is included in the Online message.

Batch format: This element and its attributes is included in the detail type message.

companyID

alpha

3

The company from where the authorization request was sent.

Order Management System updates the CMP Company field in the Authorization History table.

merchantID

alpha

20

The account number assigned by the service bureau to identify transmissions.

The system uses the following hierarchy to determine the merchant ID number to send to the service bureau:

Merchant # from the CC Paytype Cross Ref table.

Merchant ID override from the Merchant ID Override table.

Merchant ID from the Authorization Service table.

merchantReference

alpha

20

A unique number made up of the Order Management System company code + order number + order payment method sequence number + authorization sequence number.

The system uses this number to match the response to the appropriate transaction.

For stored value card activations, the order payment method sequence number and authorization sequence number are always zero.

Order Management System updates the CMP Company field, Order # field, OPM Seq # field, and AUH Seq # field in the Authorization History table.

orderID

numeric

8

The order number where the credit card payment method that requires authorization is located.

Order Management System updates the Order # field in the Authorization History table.

paymentID

numeric

2

The order payment method sequence number for this credit card payment method on the order.

Order Management System updates the OPM Seq # field in the Authorization History table.

authID

numeric

3

The order payment method sequence number for the credit card authorization request.

Order Management System updates the AUH Seq # field in the Authorization History table.

For stored value card activations, updates the Activation date in the Stored Value Card table.

ccAccountNumber

alpha

20

The card account number for the credit card payment method requesting authorization.

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

If you use credit card encryption, the system encrypts the credit card number in the Order Management System database to provide additional security of credit card data. See the Data Security and Encryption Guide for an overview.

If you use credit card tokenization, the setting of the tokenized tag defines whether the number in the ccAccountNumber tag is the actual credit card number or a token provided by the authorization service.

authNumber

alpha

7

The authorization number for the card.

For stored value card reversals, if the VendorResponse1 tag is 100, the system loads a dummy authorization number in this field.

Order Management System updates the AUH auth # field in the Authorization History table.

authAmount

numeric

10.2

The authorized amount on the card, including decimals.

If the Use Alternate Currency Pricing (H89) system control value is selected and a currency code and conversion rate are defined in the Order Header Extended table, the alternate currency displays; otherwise, the local currency displays.

Note: Stored value cards are only allowed in US currency.

Order Management System updates the AUH amount authorized field in the Authorization History table.

authDate

numeric

8

The date the credit card was authorized, in MMDDYYYY format.

Order Management System updates the AUH auth date field in the Authorization History table.

vendorResponse1

alpha

10

The response for the credit card.

Order Management System updates the AUH vendor response field in the Authorization History table.

For stored value card activations, updates the Response code in the Stored Value Card table.

vendorResponse2

alpha

10

The credit card identification response for the credit card.

Order Management System updates the AUH vendor response 2 field in the Authorization History table.

avsResponse

alpha

10

The address verification response for the credit card.

Order Management System updates the AUH AVS response field in the Authorization History table.

fraudIndicator

alpha

1

Indicates whether the customer is a possible fraud.

fraudScore

alpha

1

Future use value.

actionCode

alpha

10

Indicates the type of transaction.

Valid values:

Activation = Stored value card activation.

Balance = Stored value card balance inquiry.

Authorization = Credit card, debit card, or stored value card authorization.

Reversal = Stored value card authorization reversal.

currentBalance

numeric

12

The current balance on the stored value card.

Right justified, zero filled, with 2 implied decimals.

previousBalance

alpha

12

The previous balance on the stored value card.

Right justified, zero filled, with 2 implied decimals.

authentication Response

alpha

10

The authentication response for the authentication verification value associated with the credit card. The authentication verification value is 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.

This response is not stored in Order Management System.

transactionID

numeric

16

A unique transaction ID assigned by the service bureau for the transaction.

Updates the Transaction ID in the Authorization History table.

Available in: 2.0 (release 2.5 of Order Management System).

tokenized

alpha

1

Defines whether the number in the ccAccountNumber tag is the actual credit card number or a token. See Credit Card Tokenization in the Data Security and Encryption Guide.

Valid values:

Y = The number in the ccAccountNumber tag is a token.

N or blank = The number in the ccAccountNumber tag is the actual credit card number.

Updates the Tokenized field in the Order Payment Method table.

Available in: 3.0 (release 5.0 of Order Management System).

BatchInfo

Online format: This element and its attributes is not included in the Online message.

Batch format: This element and its attributes is included in the send, receive, and footer type messages.

fileType

alpha

4

Indicates the type of response.

Valid values:

MERC

RESP

AUTH

BILL

merchantFileTrace

numeric

3

Order Management System updates the ILC Reference ID field in the Integration Process Cntl table.

rejectReason

alpha

60

Order Management System updates the ILC reference comment field in the Integration Process Cntl table.

Included only if the authorization was declined by the service bureau.

Deposit Request XML Message (CWDepositRequest)

 

The Deposit Request XML message is used to send deposit requests to an external system when the Communication type field for the service bureau is Integration Layer.

Note: Order Management System does not currently support any base integration using an integration layer job and the Deposit Request XML Message (CWDepositRequest). Please contact your Order Management System representative if you wish to create a custom integration using this message.

Attribute Name

Type

Length

Comments

Message

This element and its attributes displays for the header, detail, summary, footer, send, and receive type messages.

source

alpha

25

Identifies the source of the XML message. RDC indicates the XML message is from Order Management System.

target

alpha

25

Identifies the target of the XML message.

type

alpha

25

Identifies the type of information in the XML message. CWDepositRequest indicates the message contains a deposit request.

resp_qmgr

alpha

48

Informational only.

resp_q

alpha

48

Informational only

CWDepositRequest

This elements and its attributes displays for the header, detail, summary, footer, send, and receive batch messages.

mode

alpha

10

Indicates the mode of communication.

Batch indicates batch deposits.

type

alpha

10

Indicates the type of message in the batch.

Valid values:

Header

Detail

Summary

Footer

Send

Receive

Service

This element and its attributes displays for the header, detail, summary, footer, send, and receive batch messages.

serviceID

alpha

3

Deposit service code.

This is the ASV Auth service code field in the Authorization Service table.

Merchant

This element and its attributes displays for the header, detail, summary, footer, send, and receive batch messages.

companyID

numeric

3

The company from where the deposit request was sent.

This is the CMP Company field in the Authorization Service table.

merchantID

alpha

20

The account number assigned by the service bureau to identify transmissions.

The system uses the following hierarchy to determine the merchant ID number to send to the service bureau:

Merchant # from the CC Paytype Cross Ref table.

Merchant ID override from the Merchant ID Override table.

Merchant ID from the Authorization Service table.

merchantSubID

alpha

10

The sub code required to sign on to the service bureau.

This is the ASV Sub code field in the Authorization Service table.

merchantName

alpha

20

The name of the service bureau.

This is the ASV Charge description field in the Authorization Service table.

merchantDivision

numeric

5

The merchant division defined by the service bureau.

This is the ASE Merchant division field in the Authorization Service Ext table.

chargeDescription

alpha

20

The name of the service bureau.

This is the ASV Charge description field in the Authorization Service table.

receivingCode

alpha

10

A code that identifies your company to the service bureau.

This is the ASV Receiving code field in the Authorization Service table.

startupInfo

alpha

10

Startup text that identifies your company to the service bureau.

This is the ASV Start up info field in the Authorization Service table.

signon

alpha

10

A code required to sign on to the service bureau.

This is the ASV Signon field in the Authorization Service table.

password

alpha

10

A password required by the service bureau.

This is the ASV Password field in the Authorization Service table.

presentersID

alpha

10

A code required to sign on to the service bureau.

This is the ASV Presenter’s ID field in the Authorization Service table.

pidPassword

alpha

10

A password required to sign on to the service bureau.

This is the ASV PID password field in the Authorization Service table.

submittersID

alpha

10

A code required to sign on to the service bureau.

This is the ASV Submitter’s ID field in the Authorization Service table.

sidPassword

alpha

10

A password required to sign on the service bureau.

This is the ASV SID password field in the Authorization Service table.

industryFormatCode

alpha

5

A code that is assigned by the service bureau to identify your company type (DBA number).

This is the ASV Industry format code field in the Authorization Service table.

addressVerificationFlag

alpha

3

Indicates whether the service bureau performs address verification to verify the customer’s address and card number.

YES = The service bureau performs address verification. The system includes the bill to name and address in the deposit request.

NO = The service bureau does not perform address verification. The system does not include the bill to name and address in the authorization request.

This is the ASV Address verification field in the Authorization Service table.

DepositRequest

This element and its attributes displays for the detail batch messages.

companyID

alpha

3

The company from where the deposit request was sent.

This is the CMP Company field in the CC Deposit Transaction table.

createDate

numeric

8

The date (in MMDDYYYY format) the deposit request was sent to the service bureau.

orderType

alpha

8

Indicates the type of order, for example phone order or mail order, where the card requiring deposit is located.

Mail = Mail order.

Phone = Telephone order.

Internet = Web order.

Order Management System:

• looks at the value in the Internet order field in the Order Header table. If this field is set to I, the order is a web order.

• determines if the order type for the order matches the E-Commerce Order Type (G42) system control value. If the order type matches, the order is a web order.

• looks at the Forecasting order category field in the Order Type table. If this value is 1, the order is a mail order. If this value is 2, the order is a phone order.

transactionType

alpha

10

Indicates whether the request is for a deposit or credit.

Purchase = deposit.

Return = credit/return.

Conditional = authorize and deposit Note: Conditional deposit is not supported for stored value cards.

merchantReference

alpha

20

A unique number made up of the Order Management System company code + order number + order payment method sequence number + authorization sequence number.

This is the CMP Company field, Order # field, OPM Seq # field in the CC Deposit Transaction table and the AUH Seq # field in the Authorization History table.

orderID

numeric

8

The order number where the credit card payment method that requires deposit is located.

This is the Order # field in the CC Deposit Transaction table.

InvoiceID

numeric

7.0

The invoice number associated with the credit card payment method.

This is the Invoice # field from the CC Deposit Transaction table.

paymentID

numeric

2

The order payment method sequence number for this credit card payment method on the order.

This is the OPM Seq # field from the CC Deposit Transaction table.

payCategory

numeric

15

A description of the pay category associated with the deposit request. Credit card displays, indicating the card is associated with the credit card pay category.

This is the description associated with the Pay category field defined for the credit card pay type in the Pay Type table.

vendorPaymentMethod

alpha

5

The vendor paytype code associated with the deposit request; this is the code the deposit service uses to identify a method of payment.

This is the CPC vendor paytype/code field defined for the credit card pay type in the CC Paytype Cross Ref table.

ccAccountNumber

alpha

16

The card number for the credit card payment method requesting deposit.

If you use credit card tokenization, this number may be a token rather than the actual credit card number.

This is the Credit card # field defined for the credit card payment in the CC Deposit Transaction table.

If you use credit card encryption, the system decrypts the credit card number before sending it to the service bureau. See Credit Card Tokenization in the Data Security and Encryption Guide for an overview.

expirationDate

numeric

4

The date the card requesting deposit expires.

This is the OPM expiration date field defined for the card in the Order Payment Method table.

depositAmountText

numeric

10.2

The amount on the card requiring deposit, including decimals.

If the Use Alternate Currency Pricing (H89) system control value is selected and a currency code and conversion rate are defined in the Order Header Extended table, the alternate currency displays; otherwise, the local currency displays.

This is the Total $ amt field defined for the card in the CC Deposit Transaction table.

depositAmount

numeric

10

The amount on the card requiring deposit, with implied decimals.

If the Use Alternate Currency Pricing (H89) system control value is selected and a currency code and conversion rate are defined in the Order Header Extended table, the alternate currency displays; otherwise, the local currency displays.

This is the Total $ amt field defined for the card in the CC Deposit Transaction table.

authID

numeric

3

The order payment method sequence number for the deposit request.

If the authID is blank (indicating the record was never authorized), the system sends an action code of B (authorize and deposit).

This is the Auth code field from the CC Deposit Transaction table.

authDate

numeric

8

The date the card was deposited, in MMDDYYYY format.

This is the Auth date field in the CC Deposit Transaction table.

merchandiseDollars

numeric

10.2

The merchandise dollar amount requiring deposit.

This is the Merchandise $ amt field defined for the card in the CC Deposit Transaction table.

freightDollars

numeric

10.2

The freight dollar amount requiring deposit.

This is the Freight $ amt field defined for the card in the CC Deposit Transaction table.

additionalFreightDollars

numeric

10.2

The additional freight dollar amount requiring deposit.

This is the Add freight $ field defined for the card in the CC Deposit Transaction table.

totalTaxDollars

numeric

10.2

The total tax dollar amount requiring deposit.

This is the Total tax $ amt field defined for the card in the CC Deposit Transaction table.

gstTaxDollars

numeric

10.2

The GST tax dollar amount requiring deposit.

This is the GST tax $ amt field defined for the card in the CC Deposit Transaction table.

pstTaxDollars

numeric

10.2

The PST tax dollar amount requiring deposit.

This is the PST tax $ amt field defined for the card in the CC Deposit Transaction table.

additionalTaxDollars

numeric

10.2

The additional tax dollar amount requiring deposit.

This is the Add tax $ amt field defined for the card in the CC Deposit Transaction table.

handlingDollars

numeric

10.2

The handling dollar amount requiring deposit.

This is the Handling $ amt field defined for the card in the CC Deposit Transaction table.

currencyCode

alpha

3

The currency code used by the deposit service to define a currency.

This is the CUR currency code field in the CC Deposit Transaction table.

CIDNumber

numeric

4

Credit Cards

The card identification number defined for the card. See Credit Card Security Service (CID, CVV2, CVC2).

This is the OPM card security value field defined for the credit card payment method in the Order Payment Method table.

Note: The card identification number is only available for online authorizations; once an order is accepted, the system removes the card identification number from the order, even if the order has not received an approved online authorization.

Stored Value Cards

The ID number assigned to the stored value card. Included only if an ID number is assigned to the card and a CID number does not exist.

From the OPM SVC ID Storage field defined for the stored value card payment in the Order Payment Method table.

CIDIndicator

alpha

1

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.

This is the OPM card security presence field defined for the credit card payment method in the Order Payment Method table.

issuingBank

alpha

10

This is the Issuing bank field defined for the payment method in the Order Payment Method table.

checkAccountNumber

alpha

20

This is the OPM Checking account field defined for the payment method in the Order Payment Method table.

checkNumber

numeric

9

This is the OPM Check number field defined for the payment method in the Order Payment Method table.

routingNumber

numeric

9

This is the OPM Routing number field defined for the payment method in the Order Payment Method table.

startDate

numeric

4

The start date of the debit card being processed, in MMYY format.

This is the Start date field in the Order Payment Method table.

issueNumber

alpha

2

The card issue number of the debit card being processed.

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

Note: The system includes the following bill to information only if the Address verification field for the authorization service is selected.

firstName

alpha

15

The first name of the bill to customer defined for the card requesting deposit.

This is the:

First name field in the Customer Bill To table, or

NAM First name field in the Customer Sold To table.

lastName

alpha

25

The last name of the bill to customer defined for the card requesting deposit.

This is the:

Last name field in the Customer Bill To table, or

NAM Last name field in the Customer Sold To table.

addressLine1

alpha

32

The street address of the bill to customer defined for the card requesting deposit.

This is the:

Street address field in the Customer Bill To table, or

NAM Street address field in the Customer Sold To table.

addressLine2

alpha

32

The second address line of the bill to customer defined for the card requesting deposit.

This is the:

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

NAM Address line 2 field in the Customer Sold To table.

city

alpha

25

The city for the address of the bill to customer defined for the card requesting deposit.

This is the:

City field in the Customer Bill To table, or

NAM City field in the Customer Sold To table.

state

alpha

2

The state for the address of the bill to customer defined for the card requesting deposit.

This is the:

State field in the Customer Bill To table, or

NAM State field in the Customer Sold To table.

zip

alpha

10

The zip code for the address of the bill to customer defined for the card requesting deposit.

This is the:

Zip field in the Customer Bill To table, or

NAM Zip field in the Customer Sold To table.

country

alpha

3

The country code for the address of the bill to customer defined for the card requesting deposit.

This is the:

RPR country field in the Customer Bill To table, or

RPR country field in the Customer Sold To table.

ecommerceIndicator

alpha

3

Represents either:

• An electronic commerce indicator code, received from an authentication service such as Visa’s Verified by Visa program or MasterCard’s SecureCode program, indicating the level of security provided for a credit card transaction placed over the internet.

• A value indicating if the order was placed on a web storefront. Valid values are:

- YES = The order was placed over the web storefront.

- NO = The order was not placed over the web storefront.

From the Ecomm Indic field in the Order Payment Method table. If this value is blank, from the E-commerce indicator (Future use sts 1 field) in the Order Header table.

authenticationValue

alpha

40

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 entered on the web storefront 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.

discountQualified

alpha

3

Indicates if the deposit is eligible for level II discounting.

YES = The deposit is eligible for level II discounting.

NO = The deposit is not eligible for level II discounting.

A deposit is eligible for level II discounting if the Send Data for Level II Discounting (I12) system control value is selected, and:

• the action code is B (conditional deposit), D (deposit), or R (refund).

• the method of payment is MC (Mastercard), VI (Visa), or AX (American Express).

• the credit card number falls within a range of numbers in the Level II Bin Range table. Note: To qualify, the number of positions in the level II bin range must match the number of positions in the credit card number. For example, if the credit card number is 4788250000121444, the level II bin range level must be 16 positions.

authDateExpired

alpha

3

Indicates if the authorization date for the deposit has expired.

YES = The authorization date for the deposit has expired. The system sends the service bureau an action code of B (authorize and deposit) and when a response is received, updates the Authorization History record with the new authorization number.

NO = The authorization date for the deposit has not expired.

The system uses the following calculation to determine if an authorization has expired: authorization date + reauthorization days = authorization expiration date

This is based on the AUH Auth date field in the Authorization History table and the PAY Reauth days field in the Pay Type table.

avsResponse

alpha

10

The AVS response received on the original authorization associated with the deposit.

This is the AUH AVS response field in the Authorization History table.

installmentMessage

alpha

18

The installment message defined for the flexible payment option deposit.

The message contains the following:

DBA industry code (3 positions): the first 3 positions of the Industry format code for the authorization service.

Merchant ID message (11 positions): the Merchant ID message field for the pay plan.

Installment description (4 positions): for installment pay plans, this is a description of which installment was deposited, for example 1of4.

For installment pay plans, the entire message is 18 positions. For deferred pay plans, the entire message is 14 positions.

The system removes any space between the merchant ID and the installment description, for example: INSTALLMSG101OF02.

purchaseOrder

alpha

15

The purchase order number associated with the deposit request.

This is the Purchase order # field defined for the order in the Order Ship To table.

reversalAmountText

numeric

10.2

The amount on the stored value card requiring authorization reversal, including decimals.

This is the difference between the authorization amount and the deposit amount. For example, if the original authorization amount was $50.00 and the deposit amount is $30.00, the reversal amount is $20.00.

Note: Stored value cards are only allowed in US currency.

This field is populated only when the Perform Authorization Reversal during Deposit Processing (J20) system control value is selected and the authorization amount is greater than the deposit amount; see Stored Value Card Authorization Reversal.

reversalAmount

numeric

10

The amount on the stored value card requiring authorization reversal, with implied decimals.

This is the difference between the authorization amount and the deposit amount. For example, if the original authorization amount was $50.00 and the deposit amount is $30.00, the reversal amount is $20.00.

Note: Stored value cards are only allowed in US currency.

This field is populated only when the Perform Authorization Reversal during Deposit Processing (J20) system control value is selected and the authorization amount is greater than the deposit amount; see Stored Value Card Authorization Reversal.

transactionID

numeric

30

The transaction ID for the authorization associated with the deposit request.

From the Transaction ID field in the Authorization History table.

tokenized

alpha

1

Defines whether the number in the ccAccountNumber is the actual credit card number or a token received from the authorization service during the credit card tokenization process. Valid values:

Y = The number in the ccAccountNumber is a token.

N = The number in the ccAccountNumber is the actual credit card number.

From the Tokenized field in the Order Payment Method table.

The system includes the tokenized tag only if the pay type is eligible for tokenization.

Available in: 3.0 (Order Management System version 5.0).

JCLstatements

Not currently implemented.

count

numeric

2

From the Authorization Service JCL table.

JCLstatement

Not currently implemented.

id

alpha

2

From the JCL Seq # field and JCL Statement field in the Authorization Service JCL table.

BatchInfo

This element and its attributes displays for the header, summary, footer, send, and receive batch messages.

fileType

alpha

4

Indicates whether the request is for a authorization and deposit or deposit.

BILL indicates card deposit request.

AUTH indicates card authorization and deposit request.

merchantFileTrace

alpha

16

The next available number from the Batch Auth File Trace Number number assignment value.

Note: The Batch Auth File Trace Number cannot be greater than 3 positions.

createDate

numeric

8

The date (in MMDDYYYY format) the deposit request was sent to the service bureau.

debitAmount

numeric

11.2

The net sales amount for this batch of deposit requests, with implied decimals.

debitCount

numeric

9

The total count of sales records for this batch of deposit requests.

creditAmount

numeric

11.2

The net refund amount for this batch of deposit requests, with implied decimals.

creditCount

numeric

9

The total count of refund records for this batch of deposit requests.

totalAmount

numeric

11.2

The total amount for this batch of deposit requests, with implied decimals.

totalCount

numeric

9

The total count for this batch of deposit requests.

testProductionFlag

alpha

4

Indicates whether the deposit request is processed in a live (production) environment or in a testing environment.

TEST = Testing environment.

PROD = Production environment.

This is the ASE Test mode field from the Authorization Service table.

Deposit Response XML Message (CWDepositResponse)

 

For each Deposit Request Message sent to the service bureau, the service bureau sends a Deposit Response XML message to Order Management System.

The Type attribute in the authorization response message identifies the type of message you are viewing in the batch (Send, Receive, Detail, Footer). A separate Detail type message is received for each deposit response in the batch.

Attribute Name

Type

Length

Comments

Message

This element and its attributes displays for the send, receive, detail, and footer batch messages.

source

alpha

25

Identifies the source of the XML message.

target

alpha

25

Identifies the target of the XML message. OROMS indicates the XML message is sent to Order Management System.

type

alpha

25

Identifies the type of information in the XML message. CWDepositResponse indicates the XML message contains a deposit response.

resp_qmgr

alpha

48

Informational only.

resp_q

alpha

48

Informational only.

CWDepositResponse

This element and its attributes displays for the send, receive, detail, and footer batch messages.

mode

alpha

10

Indicates the mode of communication.

Batch indicates batch deposits.

type

alpha

10

Indicates the type of message in the batch.

Valid values:

Header

Send

Receive

Detail

Footer

action

alpha

10

Indicates if the deposit was successful.

Complete

Confirm

Error

Failed

Receiving

Response

Rejected

Sent

Returned

NotFound

DepositResponse

This element and its attributes displays for the detail batch message.

companyID

numeric

3

The company from where the deposit request was sent.

Order Management System updates the Company field in the CC Deposit History table.

merchantID

alpha

20

The account number assigned by the service bureau to identify transmissions.

Order Management System updates the Merchant ID field defined for the deposit service in the CC Deposit History table.

merchantReference

alpha

20

A unique number made up of the Order Management System company code + order number + order payment method sequence number + authorization sequence number.

The system compares the merchantReference against the Alpha order # field in the CC Deposit Transaction table to match a received deposit with a sent deposit record.

Order Management System updates the Company field, Order # field, OPM seq # field, and Seq # field in the CC Deposit History table.

orderID

numeric

8

The order number where the credit card payment method that requires deposit is located.

Order Management System updates the Order # field in the CC Deposit History table.

invoiceID

numeric

7

The invoice number associated with the credit card payment method.

Order Management System updates the Invoice # field in the CC Deposit History table.

paymentID

numeric

2

The order payment method sequence number for this credit card payment method on the order.

Order Management System updates the OPM Seq # field in the CC Deposit History table.

ccAccountNumber

alpha

16

The card number for the credit card payment method requesting deposit.

If you use credit card tokenization, this number may be a token rather than the actual credit card number.

Order Management System updates the Credit card # field in the CC Deposit History table.

If you use credit card encryption, the system encrypts the credit card number in the Order Management System database to provide additional security of credit card data. See Credit Card Tokenization in the Data Security and Encryption Guide for an overview.

authNumber

alpha

10

The authorization code for the deposit.

If the authorization number returned is NOTDEP or notdep, the system rejects the deposit.

Order Management System updates the Authorization code field in the CC Deposit History table.

AuthAmount

numeric

10

The authorized deposit amount on the card, with implied decimals.

Order Management System updates the Deposit amount field in the CC Deposit History table.

authDate

numeric

8

The date the deposit was authorized, in MMDDYYYY format.

Order Management System updates the Deposit date field in the CC Deposit History table.

vendorResponse1

alpha

10

The deposit response for the card.

Order Management System updates the Response code field in the CC Deposit History table.

vendorResponse2

alpha

10

The card identification response for the card.

avsResponse

alpha

10

The address verification response for the credit card.

fraudIndicator

alpha

1

Indicates whether the customer is a possible fraud.

This is a future-use value.

fraudScore

alpha

1

This is a future-use value.

depositFlag

alpha

3

Indicates if the deposit was successful, based on the response code received back from the service bureau and an authorization number of NOTDEP.

YES = The deposit was approved by the service bureau (the VendorResponse1 is 100 approved).

NO = The deposit was rejected by the service bureau.

authenticationResponse

alpha

10

The authentication response for the authentication verification value associated with the credit card. The authentication verification value is 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.

Not stored in Order Management System.

BatchInfo

This element and its attributes displays for the send, receive, and footer batch messages.

fileType

alpha

4

Indicates the type of response.

Valid values:

MERC

RESP

AUTH

BILL

merchantFileTrace

integer

3

Order Management System updates the ILC Reference ID field in the Integration Process Cntl table.

rejectReason

alpha

60

Order Management System updates the ILC reference comment field in the Integration Process Cntl table.

Included only if the deposit was declined by the service bureau.

SO04_13 OROMS 17.0 2018 OTN