ExternalCardholderAuthenticationData (onlinepayments-sdk-java 4.12.0 API)

java.lang.Object
- com.onlinepayments.domain.ExternalCardholderAuthenticationData

public class ExternalCardholderAuthenticationData
extends Object

Object containing 3D secure details.

Constructor Summary

Constructors
Constructor and Description

ExternalCardholderAuthenticationData()

Constructors
Constructor and Description
`ExternalCardholderAuthenticationData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAcsTransactionId()` Identifier of the authenticated transaction at the ACS/Issuer.
`String`	`getAppliedExemption()` Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
`String`	`getCavv()` The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
`String`	`getCavvAlgorithm()` The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
`String`	`getDirectoryServerTransactionId()` The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
`Integer`	`getEci()` Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
`String`	`getFlow()` 3D Secure Flow used during this transaction.
`Integer`	`getSchemeRiskScore()` Global score calculated by the Carte Bancaire (130) Scoring platform.
`String`	`getThreeDSecureVersion()` The 3-D Secure version used for the authentication.
`String`	`getXid()` The transaction ID that is used for the 3D Authentication
`void`	`setAcsTransactionId(String value)` Identifier of the authenticated transaction at the ACS/Issuer.
`void`	`setAppliedExemption(String value)` Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
`void`	`setCavv(String value)` The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
`void`	`setCavvAlgorithm(String value)` The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
`void`	`setDirectoryServerTransactionId(String value)` The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
`void`	`setEci(Integer value)` Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
`void`	`setFlow(String value)` 3D Secure Flow used during this transaction.
`void`	`setSchemeRiskScore(Integer value)` Global score calculated by the Carte Bancaire (130) Scoring platform.
`void`	`setThreeDSecureVersion(String value)` The 3-D Secure version used for the authentication.
`void`	`setXid(String value)` The transaction ID that is used for the 3D Authentication
`ExternalCardholderAuthenticationData`	`withAcsTransactionId(String value)` Identifier of the authenticated transaction at the ACS/Issuer.
`ExternalCardholderAuthenticationData`	`withAppliedExemption(String value)` Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
`ExternalCardholderAuthenticationData`	`withCavv(String value)` The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
`ExternalCardholderAuthenticationData`	`withCavvAlgorithm(String value)` The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
`ExternalCardholderAuthenticationData`	`withDirectoryServerTransactionId(String value)` The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
`ExternalCardholderAuthenticationData`	`withEci(Integer value)` Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
`ExternalCardholderAuthenticationData`	`withFlow(String value)` 3D Secure Flow used during this transaction.
`ExternalCardholderAuthenticationData`	`withSchemeRiskScore(Integer value)` Global score calculated by the Carte Bancaire (130) Scoring platform.
`ExternalCardholderAuthenticationData`	`withThreeDSecureVersion(String value)` The 3-D Secure version used for the authentication.
`ExternalCardholderAuthenticationData`	`withXid(String value)` The transaction ID that is used for the 3D Authentication

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExternalCardholderAuthenticationData
```
public ExternalCardholderAuthenticationData()
```
- Method Detail
  - getAcsTransactionId
```
public String getAcsTransactionId()
```
    Identifier of the authenticated transaction at the ACS/Issuer.
  - setAcsTransactionId
```
public void setAcsTransactionId(String value)
```
    Identifier of the authenticated transaction at the ACS/Issuer.
  - withAcsTransactionId
```
public ExternalCardholderAuthenticationData withAcsTransactionId(String value)
```
    Identifier of the authenticated transaction at the ACS/Issuer.
  - getAppliedExemption
```
public String getAppliedExemption()
```
    Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
  - setAppliedExemption
```
public void setAppliedExemption(String value)
```
    Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
  - withAppliedExemption
```
public ExternalCardholderAuthenticationData withAppliedExemption(String value)
```
    Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
  - getCavv
```
public String getCavv()
```
    The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value. Note: This is mandatory for ECI 2 and 5.
  - setCavv
```
public void setCavv(String value)
```
    The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value. Note: This is mandatory for ECI 2 and 5.
  - withCavv
```
public ExternalCardholderAuthenticationData withCavv(String value)
```
    The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value. Note: This is mandatory for ECI 2 and 5.
  - getCavvAlgorithm
```
public String getCavvAlgorithm()
```
    The algorithm, from your 3D Secure provider, used to generate the authentication CAVV. Note: Required when * The 3D Secure authentication for the transaction is managed by a third-party 3D Secure authentication provider * You process the transaction through Atos
  - setCavvAlgorithm
```
public void setCavvAlgorithm(String value)
```
    The algorithm, from your 3D Secure provider, used to generate the authentication CAVV. Note: Required when * The 3D Secure authentication for the transaction is managed by a third-party 3D Secure authentication provider * You process the transaction through Atos
  - withCavvAlgorithm
```
public ExternalCardholderAuthenticationData withCavvAlgorithm(String value)
```
    The algorithm, from your 3D Secure provider, used to generate the authentication CAVV. Note: Required when * The 3D Secure authentication for the transaction is managed by a third-party 3D Secure authentication provider * You process the transaction through Atos
  - getDirectoryServerTransactionId
```
public String getDirectoryServerTransactionId()
```
    The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
  - setDirectoryServerTransactionId
```
public void setDirectoryServerTransactionId(String value)
```
    The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
  - withDirectoryServerTransactionId
```
public ExternalCardholderAuthenticationData withDirectoryServerTransactionId(String value)
```
    The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
  - getEci
```
public Integer getEci()
```
    Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
  - setEci
```
public void setEci(Integer value)
```
    Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
  - withEci
```
public ExternalCardholderAuthenticationData withEci(Integer value)
```
    Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
  - getFlow
```
public String getFlow()
```
    3D Secure Flow used during this transaction.
  - setFlow
```
public void setFlow(String value)
```
    3D Secure Flow used during this transaction.
  - withFlow
```
public ExternalCardholderAuthenticationData withFlow(String value)
```
    3D Secure Flow used during this transaction.
  - getSchemeRiskScore
```
public Integer getSchemeRiskScore()
```
    Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
  - setSchemeRiskScore
```
public void setSchemeRiskScore(Integer value)
```
    Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
  - withSchemeRiskScore
```
public ExternalCardholderAuthenticationData withSchemeRiskScore(Integer value)
```
    Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
  - getThreeDSecureVersion
```
public String getThreeDSecureVersion()
```
    The 3-D Secure version used for the authentication. Possible values: * v1 * v2 * 1.0.2 * 2.1.0 * 2.2.0
  - setThreeDSecureVersion
```
public void setThreeDSecureVersion(String value)
```
    The 3-D Secure version used for the authentication. Possible values: * v1 * v2 * 1.0.2 * 2.1.0 * 2.2.0
  - withThreeDSecureVersion
```
public ExternalCardholderAuthenticationData withThreeDSecureVersion(String value)
```
    The 3-D Secure version used for the authentication. Possible values: * v1 * v2 * 1.0.2 * 2.1.0 * 2.2.0
  - getXid
```
public String getXid()
```
    The transaction ID that is used for the 3D Authentication
  - setXid
```
public void setXid(String value)
```
    The transaction ID that is used for the 3D Authentication
  - withXid
```
public ExternalCardholderAuthenticationData withXid(String value)
```
    The transaction ID that is used for the 3D Authentication

Class ExternalCardholderAuthenticationData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExternalCardholderAuthenticationData

Method Detail

getAcsTransactionId

setAcsTransactionId

withAcsTransactionId

getAppliedExemption

setAppliedExemption

withAppliedExemption

getCavv

setCavv

withCavv

getCavvAlgorithm

setCavvAlgorithm

withCavvAlgorithm

getDirectoryServerTransactionId

setDirectoryServerTransactionId

withDirectoryServerTransactionId

getEci

setEci

withEci

getFlow

setFlow

withFlow

getSchemeRiskScore

setSchemeRiskScore

withSchemeRiskScore

getThreeDSecureVersion

setThreeDSecureVersion

withThreeDSecureVersion

getXid

setXid

withXid