...
| Note |
|---|
Cardinal support for the Visa Digital Authentication Framework is currently considered Beta. The integration and corresponding documentation are subject to change. |
Field Name | Description | Condition | Field Definition | ||||||
|---|---|---|---|---|---|---|---|---|---|
CustomerId
| Unique value assigned by the merchant to the transacting cardholder that can be used to manage state of the authenticated payment credential. Example:
| Required for | AN(254) | ||||||
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. | Required for | 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. | Required for | N(3) | ||||||
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. | Required for | AN(50) | ||||||
BillingPostalCode | Consumer's postal code of their billing address. | Required for | AN(16) | ||||||
BillingState | Consumer's state or province of their billing address. Note: Should be the country subdivision code defined in ISO 3166-2. The subdivision is code is what follows the hyphen separator in the full ISO 3166-2 code. For example, the state of Ohio in the United States is: | Required for | AN(3) | ||||||
Consumer's email address. | Required | 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 | Required for | N(25) | ||||||
IPAddress | The IP address of the Consumer. Note: IPv4 and IPv6 are supported. Example: IPv4 address: <IPAddress>1.12.123.255</IPAddress> IPv6 address: <IPAddress>2011:0db8:85a3:0101:0101:8a2e:03 70:7334</IPAddress> | Required for | AN(45) | ||||||
AuthenticationIndicator | Indicates the type of Authentication request.
| Required if merchant wants to initiate a 3RI request on a subsequent transactions. | N(2) | ||||||
PurchaseDate | Date of original purchase. Format: YYYYMMDDHHMMSS NOTE: If not passed, Cardinal will use current date. Required for recurring transactions. NOTE: Supports 3RI Device Channel in version 2.2.0 | Required for Recurring and Installment transactions. | AN(14) | ||||||
RecurringEnd | The date after which no further recurring authorizations should be performed. Format: YYYYMMDD NOTE: Supports 3RI Device Channel in version 2.2.0 | Required for Recurring and Installment transactions. | N(8) | ||||||
RecurringFrequency | Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 Example values accepted (31 days):
NOTE: Supports 3RI Device Channel in version 2.2.0 | Required for Recurring and Installment transactions. | N(4) | ||||||
Merchant Initiated Transactions (3RI) | |||||||||
ThreeRIIndicator | Indicates the type of 3RI request. Possible Values:
| Required for | |||||||
. | N(2) | ||
AlternatePriorAuthenticationTime | Date and time in UTC of the prior cardholder authentication. Format YYYYMMDDHHMM | Required for 3RI transactions | N(12) |
AlternatePriorAuthenticationRef | This data element contains a ACS Transaction ID for a prior authenticated transaction For example, the first recurring transaction that was authenticated with the cardholder | Required for 3RI transactions | AN(36) |
AlternatePriorAuthenticationMethod | Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. 01 - Frictionless authentication occurred by ACS 02 - Cardholder challenge occurred by ACS 03 - AVS verified 04 - Other issuer methods 05-79 - Reserved for EMVCo future use (values invalid until defined by EMVCo) 80-99 - Reserved for DS use | Required for 3RI transactions | N(2) |