com.ingenico.direct.domain.ExternalCardholderAuthenticationData Maven / Gradle / Ivy

/*
 * This class was auto-generated from the API references found at
 * https://support.direct.ingenico.com/documentation/api/reference
 */
package com.ingenico.direct.domain;

/**
 * Object containing 3D secure details.
 */
public class ExternalCardholderAuthenticationData {

	private String acsTransactionId = null;

	private String appliedExemption = null;

	private String cavv = null;

	private String cavvAlgorithm = null;

	private String directoryServerTransactionId = null;

	private Integer eci = null;

	private Integer schemeRiskScore = null;

	private String threeDSecureVersion = null;

	private String xid = null;

	/**
	 * Identifier of the authenticated transaction at the ACS/Issuer.
	 */
	public String getAcsTransactionId() {
		return acsTransactionId;
	}

	/**
	 * Identifier of the authenticated transaction at the ACS/Issuer.
	 */
	public void setAcsTransactionId(String value) {
		this.acsTransactionId = value;
	}

	/**
	 * Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
	 */
	public String getAppliedExemption() {
		return appliedExemption;
	}

	/**
	 * Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
	 */
	public void setAppliedExemption(String value) {
		this.appliedExemption = 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.
	 */
	public String getCavv() {
		return cavv;
	}

	/**
	 * 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.
	 */
	public void setCavv(String value) {
		this.cavv = 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 non-Ingenico ePayments 3D Secure authentication provider
	 *   * You process the transaction through Atos
	 */
	public String getCavvAlgorithm() {
		return cavvAlgorithm;
	}

	/**
	 * 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 non-Ingenico ePayments 3D Secure authentication provider
	 *   * You process the transaction through Atos
	 */
	public void setCavvAlgorithm(String value) {
		this.cavvAlgorithm = value;
	}

	/**
	 * The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
	 * Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
	 */
	public String getDirectoryServerTransactionId() {
		return directoryServerTransactionId;
	}

	/**
	 * The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
	 * Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
	 */
	public void setDirectoryServerTransactionId(String value) {
		this.directoryServerTransactionId = 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
	 */
	public Integer getEci() {
		return eci;
	}

	/**
	 * 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
	 */
	public void setEci(Integer value) {
		this.eci = value;
	}

	/**
	 * Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
	 */
	public Integer getSchemeRiskScore() {
		return schemeRiskScore;
	}

	/**
	 * Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
	 */
	public void setSchemeRiskScore(Integer value) {
		this.schemeRiskScore = value;
	}

	/**
	 * The 3-D Secure version used for the authentication. Possible values:
	 * * v1
	 * * v2
	 * * 1.0.2
	 * * 2.1.0
	 * * 2.2.0
	 */
	public String getThreeDSecureVersion() {
		return threeDSecureVersion;
	}

	/**
	 * The 3-D Secure version used for the authentication. Possible values:
	 * * v1
	 * * v2
	 * * 1.0.2
	 * * 2.1.0
	 * * 2.2.0
	 */
	public void setThreeDSecureVersion(String value) {
		this.threeDSecureVersion = value;
	}

	/**
	 * The transaction ID that is used for the 3D Authentication
	 */
	public String getXid() {
		return xid;
	}

	/**
	 * The transaction ID that is used for the 3D Authentication
	 */
	public void setXid(String value) {
		this.xid = value;
	}
}