Ch 34 (02/20/2020): Moved Billing State from Required Fields to Conditional Required Fields
Changes made on 2020-02-20 are delineated below.
Additions are underlined in Green. Deletions are underlined in Red. Modifications are underlined in Blue.
Change Occurred On: https://cardinaldocs.atlassian.net/wiki/spaces/CCen/pages/905478187
Required Fields
These fields are required to initiate a Cardinal Consumer Authentication transaction.
Field Name | Description | Required | Field Definition |
---|---|---|---|
Amount | Unformatted total transaction amount without any decimalization. Example: $100.00 = 10000, $123.67 = 12367, $.99 = 99 | Y | N(17) |
BillingAddress1 | Consumer's billing address information. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | Y | AN(50) |
BillingCity | Consumer's city on their billing address. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | Y | AN(50) |
BillingCountryCode | Consumer's numeric 3-digit ISO 3166-1 country code. Example: United States = 840 NOTE: Please see the Visa Required mapping for countries such as Saint Barthelemy, Guernsey, Jersey, Isle of Man & Aland Islands below. | Y | N(3) |
BillingFirstName | Consumer's first name. | Y | AN(22) |
BillingLastName | Consumer's last name. | Y | AN(22) |
BillingPostalCode | Consumer's postal code of their billing address. | Y | AN(16) |
BillingState
| Consumer's state or province of their billing address. NOTE: Should be the country subdivision code defined in ISO 3166-2. | C | AN(3) |
CardExpMonth | Card number expiration month. Formatted MM Example: January = 01 | Y | N(2) |
CardExpYear | Card number expiration year. Formatted YYYY Example: YYYY = 2016 | Y | N(4) |
CardNumber | Consumer's credit card number. | Y | N(19) |
CurrencyCode | 3 digit numeric ISO 4217 currency code for the sale amount. | Y | N(3) |
DFReferenceId | Reference Id that relates to the device data that was previously collected. NOTE: In the Cruise Hybrid Integration, this field will need to match the ReferenceId claim in the JWT or the sessionId from the payments.setupComplete event handler. | Y | AN(50) |
Consumer's email address. | Y | AN(254) | |
MobilePhone | Consumer's phone number for mobile phone. This should be unformatted without hyphens. NOTE: This information will be passed to the Directory Server if the phone has a + sign and a country code. Examples: (US) + 1-222-234-5678 = +12222345678 (UK) + 44-1234-123456 = +441234123456 NOTE: This field is required for VISA Brazil extensions | Y | N(25) |
ProcessorId | Merchant Processor identification code. This value is assigned to the Merchant by CardinalCommerce. | Y | AN(20) |
MerchantId | Merchant identification code. This value is assigned to the Merchant by CardinalCommerce. | Y | AN(50) |
TransactionPwd | A password to secure and verify the transaction originated from Merchant represented by the transaction details. The password value is configured through the Merchant profile. | Y | AN(50) |
Version | Application message identifier. Current Version - 1.7 | Y | AN(3) |
TransactionMode | Transaction mode identifier. Identifies the channel the transaction originates from. Available Options: M - Moto (Mail Order Telephone Order) P - Mobile Device R - Retail (Physical Store) S - Computer Device T - Tablet Device | O | A(1) |
MsgType | cmpi_lookup | Y | AN(50) |
TransactionType | Identifies the transaction type used for processing. Possible Values: C - Credit Card/Debit Card Authentication | Y | AN(3) |
OrderNumber | Order Number or transaction identifier from the Merchant commerce website. | Y | AN(50) |
Conditionally Required Fields
The requirements for these fields are driven by the conditions of the transaction.
Field Name | Description | Required | Condition | Field Definition |
---|---|---|---|---|
ShippingAddress1 | Consumer's shipping address information. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | C | Required if information is available. | AN(50) |
ShippingState | Consumer's state or province of their shipping address. NOTE: Should be the country subdivision code defined in ISO 3166-2. | C | Required if information is available. | AN(3) |
ShippingCity | Consumer's city of their shipping address. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | C | Required if information is available. | AN(50) |
ShippingCountryCode | Consumer's 3-digit ISO 3166-1 country code. NOTE: Please see the Visa Required mapping for countries such as Saint Barthelemy, Guernsey, Jersey, Isle of Man & Aland Islands below. | C | Required if information is available. | AN(3) |
ShippingAddress2 | Consumer's shipping address information. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | C | Required if information is available. | AN(50) |
ShippingAddress3 | Consumer's shipping address information. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | C | Required if information is available. | AN(50) |
ShippingPostalCode | Consumer's postal code of their shipping address. | C | Required if information is available. | AN(16) |
BillingState | Consumer's state or province of their billing address. NOTE: Should be the country subdivision code defined in ISO 3166-2. | C | Required if information is applicable | AN(3) |
BillingPhone | Consumer's phone number for billing address. This should be unformatted without hyphens. NOTE: This information will be passed to the Directory Server if the phone has a + sign and a country code. Examples: (US) + 1-222-234-5678 = +12222345678 (UK) + 44-1234-123456 = +441234123456 | C | Required if information is available. | N(20) |
WorkPhone | Consumer's work phone number. | C | Required if information is available. | N(25) |
BillingAddress2 | Consumer's billing address information. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | C | Required if information is available. | AN(50) |
BillingAddress3 | Consumer's billing address information. NOTE: If the value passed is greater than the field definition, it will be truncated to the maximum allowable value. | C | Required if information is available. | AN(50) |
AuthenticationIndicator | Indicates the type of Authentication request. 01 - Payment transaction 02 - Recurring transaction 03 - Installment transaction 04 - Add card 05 - Maintain card 06 - Cardholder verification as part of EMV token ID&V | C | Required if not a Payment transaction. | N(2) |
ProductCode | Merchant product code. Possible Values: PHY - Goods/Service Purchase CHA - Check Acceptance ACF - Account Funding QCT - Quasi-Cash Transaction PAL - Prepaid Activation and Load NOTE: This value defaults to PHY. This field can be used to override that value if applicable. | C | Required is the value if anything other than PHY | AN(3) |
ThreeDSVersion | This field contains the 3DS version that can be leveraged to force a transaction down the 1.0 rails. Possible Values: 1.0.2 | C | Required if transaction is leveraged to process via 1.0 rails and not EMV 3DS 2.1+ rails | AN(10) |