cardholderAuthentication

The cardholderAuthentication element is an optional child element of the Authorization and Sale transactions. The children of this element have two purposes. The first is to define Verified by Visa or Mastercard SecureCode data in the Authorization or Sale transactions (authenticationValue, authenticationTransactionId, and authenticatedByMerchant elements). The remaining child element, customerIpAddress, as well as the authenticationTransactionId, are used in PayPal Credit transactions. The customerIpAddress element can also be used to supply the customer IP Address by merchants enabled for American Express Advanced AVS services.

Parent Elements:

authorization, sale

Attributes:

None

Child Elements:

authenticationValue, authenticationProtocolVersion, authenticationTransactionId, customerIpAddress, authenticatedByMerchant, tokenAuthenticationValue

Example: cardholderAuthentication Structure

<cardholderAuthentication>

  <authenticationValue>BwABBJQ1AgAAAAAgJDUCAAAAAAA=</authenticationValue>

  <authenticationTransactionId>EaOMucALHQqLAEGAgk=</authenticationTransactionId>

  <customerIpAddress>Customer Ip</customerIpAddress>

  <authenticatedByMerchant>Boolean</authenticatedByMerchant>

  <authenticationProtocolVersion>1 or 2</authenticationProtocolVersion>

  <tokenAuthenticationValue>BwABBJQ1AgAAAAAgJDUCAAAAAAA=</tokenAuthenticationValue>

</cardholderAuthentication>

For Visa 3DS1 or 3DS2 fully authenticated transactions, if you include the optional <authenticationTransactionId>element, populate it with the base64 encoded Xid (Transaction ID from 3DS provider). For Mastercard 3DS2 fully authenticated transactions you must include the <authenticationTransactionId>element populated with the directory_server_txn_id from the 3DS provider in UUID format. The values for the <authenticationValue> and <authenticationTransactionId> elements in the example above have been truncated.