com.onlinepayments.domain

Class ThreeDSecure

java.lang.Object

com.onlinepayments.domain.ThreeDSecure

public class ThreeDSecure
extends Object

Object containing specific data regarding 3-D Secure

Constructor Summary

Constructors

Constructor and Description
ThreeDSecure()

Method Summary

Modifier and Type	Method and Description
Long	getAuthenticationAmount() Allows amount to be authenticated to be different from amount authorized.
String	getChallengeCanvasSize() Dimensions of the challenge window that potentially will be displayed to the customer.
String	getChallengeIndicator() Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
String	getExemptionRequest() In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
ExternalCardholderAuthenticationData	getExternalCardholderAuthenticationData() Object containing 3D secure details.
Integer	getMerchantFraudRate() Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS.
ThreeDSecureData	getPriorThreeDSecureData() Object containing data regarding the customer authentication that occurred prior to the current transaction
RedirectionData	getRedirectionData() Object containing browser specific redirection related data
Boolean	getSecureCorporatePayment() Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank.
Boolean	getSkipAuthentication() * true = 3D Secure authentication will be skipped for this transaction.
Boolean	getSkipSoftDecline() * true = Soft Decline retry mechanism will be skipped for this transaction.
void	setAuthenticationAmount(Long value) Allows amount to be authenticated to be different from amount authorized.
void	setChallengeCanvasSize(String value) Dimensions of the challenge window that potentially will be displayed to the customer.
void	setChallengeIndicator(String value) Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
void	setExemptionRequest(String value) In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
void	setExternalCardholderAuthenticationData(ExternalCardholderAuthenticationData value) Object containing 3D secure details.
void	setMerchantFraudRate(Integer value) Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS.
void	setPriorThreeDSecureData(ThreeDSecureData value) Object containing data regarding the customer authentication that occurred prior to the current transaction
void	setRedirectionData(RedirectionData value) Object containing browser specific redirection related data
void	setSecureCorporatePayment(Boolean value) Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank.
void	setSkipAuthentication(Boolean value) * true = 3D Secure authentication will be skipped for this transaction.
void	setSkipSoftDecline(Boolean value) * true = Soft Decline retry mechanism will be skipped for this transaction.
ThreeDSecure	withAuthenticationAmount(Long value) Allows amount to be authenticated to be different from amount authorized.
ThreeDSecure	withChallengeCanvasSize(String value) Dimensions of the challenge window that potentially will be displayed to the customer.
ThreeDSecure	withChallengeIndicator(String value) Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
ThreeDSecure	withExemptionRequest(String value) In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
ThreeDSecure	withExternalCardholderAuthenticationData(ExternalCardholderAuthenticationData value) Object containing 3D secure details.
ThreeDSecure	withMerchantFraudRate(Integer value) Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS.
ThreeDSecure	withPriorThreeDSecureData(ThreeDSecureData value) Object containing data regarding the customer authentication that occurred prior to the current transaction
ThreeDSecure	withRedirectionData(RedirectionData value) Object containing browser specific redirection related data
ThreeDSecure	withSecureCorporatePayment(Boolean value) Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank.
ThreeDSecure	withSkipAuthentication(Boolean value) * true = 3D Secure authentication will be skipped for this transaction.
ThreeDSecure	withSkipSoftDecline(Boolean value) * true = Soft Decline retry mechanism will be skipped for this transaction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ThreeDSecure

public ThreeDSecure()

Method Detail

getAuthenticationAmount

public Long getAuthenticationAmount()

Allows amount to be authenticated to be different from amount authorized. (Amount in cents and always having 2 decimals)

setAuthenticationAmount

public void setAuthenticationAmount(Long value)

Allows amount to be authenticated to be different from amount authorized. (Amount in cents and always having 2 decimals)

withAuthenticationAmount

public ThreeDSecure withAuthenticationAmount(Long value)

Allows amount to be authenticated to be different from amount authorized. (Amount in cents and always having 2 decimals)

getChallengeCanvasSize

public String getChallengeCanvasSize()

Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are * 250x400 (default) * 390x400 * 500x600 * 600x400 * full-screen

setChallengeCanvasSize

public void setChallengeCanvasSize(String value)

Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are * 250x400 (default) * 390x400 * 500x600 * 600x400 * full-screen

withChallengeCanvasSize

public ThreeDSecure withChallengeCanvasSize(String value)

Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are * 250x400 (default) * 390x400 * 500x600 * 600x400 * full-screen

getChallengeIndicator

public String getChallengeIndicator()

Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values: * no-preference - You have no preference whether or not to challenge the customer (default) * no-challenge-requested - you prefer the cardholder not to be challenged * challenge-requested - you prefer the customer to be challenged * challenge-required - you require the customer to be challenged * no-challenge-requested-risk-analysis-performed – letting the issuer know that you have already assessed the transaction with fraud prevention tool * no-challenge-requested-data-share-only – sharing data only with the DS * no-challenge-requested-consumer-authentication-performed – authentication already happened at your side – when login in to your website * no-challenge-requested-use-whitelist-exemption – cardholder has whitelisted you at with the issuer * challenge-requested-whitelist-prompt-requested – cardholder is trying to whitelist you * request-scoring-without-connecting-to-acs – sending information to CB DS for a fraud scoring

setChallengeIndicator

public void setChallengeIndicator(String value)

Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values: * no-preference - You have no preference whether or not to challenge the customer (default) * no-challenge-requested - you prefer the cardholder not to be challenged * challenge-requested - you prefer the customer to be challenged * challenge-required - you require the customer to be challenged * no-challenge-requested-risk-analysis-performed – letting the issuer know that you have already assessed the transaction with fraud prevention tool * no-challenge-requested-data-share-only – sharing data only with the DS * no-challenge-requested-consumer-authentication-performed – authentication already happened at your side – when login in to your website * no-challenge-requested-use-whitelist-exemption – cardholder has whitelisted you at with the issuer * challenge-requested-whitelist-prompt-requested – cardholder is trying to whitelist you * request-scoring-without-connecting-to-acs – sending information to CB DS for a fraud scoring

withChallengeIndicator

public ThreeDSecure withChallengeIndicator(String value)

Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values: * no-preference - You have no preference whether or not to challenge the customer (default) * no-challenge-requested - you prefer the cardholder not to be challenged * challenge-requested - you prefer the customer to be challenged * challenge-required - you require the customer to be challenged * no-challenge-requested-risk-analysis-performed – letting the issuer know that you have already assessed the transaction with fraud prevention tool * no-challenge-requested-data-share-only – sharing data only with the DS * no-challenge-requested-consumer-authentication-performed – authentication already happened at your side – when login in to your website * no-challenge-requested-use-whitelist-exemption – cardholder has whitelisted you at with the issuer * challenge-requested-whitelist-prompt-requested – cardholder is trying to whitelist you * request-scoring-without-connecting-to-acs – sending information to CB DS for a fraud scoring

getExemptionRequest

public String getExemptionRequest()

In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up. * none = No exemption requested * transaction-risk-analysis = Fraud analysis has been done already by your own fraud module and transaction scored as low risk * low-value = Bellow 30 euros * whitelist = The cardholder has whitelisted you with their issuer

setExemptionRequest

public void setExemptionRequest(String value)

In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up. * none = No exemption requested * transaction-risk-analysis = Fraud analysis has been done already by your own fraud module and transaction scored as low risk * low-value = Bellow 30 euros * whitelist = The cardholder has whitelisted you with their issuer

withExemptionRequest

public ThreeDSecure withExemptionRequest(String value)

In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up. * none = No exemption requested * transaction-risk-analysis = Fraud analysis has been done already by your own fraud module and transaction scored as low risk * low-value = Bellow 30 euros * whitelist = The cardholder has whitelisted you with their issuer

getExternalCardholderAuthenticationData

public ExternalCardholderAuthenticationData getExternalCardholderAuthenticationData()

Object containing 3D secure details.

setExternalCardholderAuthenticationData

public void setExternalCardholderAuthenticationData(ExternalCardholderAuthenticationData value)

Object containing 3D secure details.

withExternalCardholderAuthenticationData

public ThreeDSecure withExternalCardholderAuthenticationData(ExternalCardholderAuthenticationData value)

Object containing 3D secure details.

getMerchantFraudRate

public Integer getMerchantFraudRate()

Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS. Mastercard will not calculate or validate the merchant fraud score Values accepted : * 1 - represents fraud rate less than or equal to 1 basis point [bp], which is 0.01% * 2 - represents fraud rate between 1 bp + - and 6 bps * 3 - represents fraud rate between 6 bps + - and 13 bps * 4 - represents fraud rate between 13 bps + - and 25 bps * 5 - represents fraud rate greater than 25 bps

setMerchantFraudRate

public void setMerchantFraudRate(Integer value)

Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS. Mastercard will not calculate or validate the merchant fraud score Values accepted : * 1 - represents fraud rate less than or equal to 1 basis point [bp], which is 0.01% * 2 - represents fraud rate between 1 bp + - and 6 bps * 3 - represents fraud rate between 6 bps + - and 13 bps * 4 - represents fraud rate between 13 bps + - and 25 bps * 5 - represents fraud rate greater than 25 bps

withMerchantFraudRate

public ThreeDSecure withMerchantFraudRate(Integer value)

Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS. Mastercard will not calculate or validate the merchant fraud score Values accepted : * 1 - represents fraud rate less than or equal to 1 basis point [bp], which is 0.01% * 2 - represents fraud rate between 1 bp + - and 6 bps * 3 - represents fraud rate between 6 bps + - and 13 bps * 4 - represents fraud rate between 13 bps + - and 25 bps * 5 - represents fraud rate greater than 25 bps

getPriorThreeDSecureData

public ThreeDSecureData getPriorThreeDSecureData()

Object containing data regarding the customer authentication that occurred prior to the current transaction

setPriorThreeDSecureData

public void setPriorThreeDSecureData(ThreeDSecureData value)

Object containing data regarding the customer authentication that occurred prior to the current transaction

withPriorThreeDSecureData

public ThreeDSecure withPriorThreeDSecureData(ThreeDSecureData value)

Object containing data regarding the customer authentication that occurred prior to the current transaction

getRedirectionData

public RedirectionData getRedirectionData()

Object containing browser specific redirection related data

setRedirectionData

public void setRedirectionData(RedirectionData value)

Object containing browser specific redirection related data

withRedirectionData

public ThreeDSecure withRedirectionData(RedirectionData value)

Object containing browser specific redirection related data

getSecureCorporatePayment

public Boolean getSecureCorporatePayment()

Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank. A merchant cannot claim both acquirer exemption and secure payment. However, the DS will not validate the conditions in the extension. DS will pass data as presented.

setSecureCorporatePayment

public void setSecureCorporatePayment(Boolean value)

Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank. A merchant cannot claim both acquirer exemption and secure payment. However, the DS will not validate the conditions in the extension. DS will pass data as presented.

withSecureCorporatePayment

public ThreeDSecure withSecureCorporatePayment(Boolean value)

Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank. A merchant cannot claim both acquirer exemption and secure payment. However, the DS will not validate the conditions in the extension. DS will pass data as presented.

getSkipAuthentication

public Boolean getSkipAuthentication()

* true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to "recurring" * false = 3D Secure authentication will not be skipped for this transaction Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction

setSkipAuthentication

public void setSkipAuthentication(Boolean value)

* true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to "recurring" * false = 3D Secure authentication will not be skipped for this transaction Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction

withSkipAuthentication

public ThreeDSecure withSkipAuthentication(Boolean value)

* true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to "recurring" * false = 3D Secure authentication will not be skipped for this transaction Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction

getSkipSoftDecline

public Boolean getSkipSoftDecline()

* true = Soft Decline retry mechanism will be skipped for this transaction. The transaction will result in "Authorization Declined" status. This setting should be used when skipAuthentication is set to true and the merchant does not want to use Soft Decline retry mechanism. * false = Soft Decline retry mechanism will not be skipped for this transaction. Note: skipSoftDecline defaults to false if empty. This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.

setSkipSoftDecline

public void setSkipSoftDecline(Boolean value)

* true = Soft Decline retry mechanism will be skipped for this transaction. The transaction will result in "Authorization Declined" status. This setting should be used when skipAuthentication is set to true and the merchant does not want to use Soft Decline retry mechanism. * false = Soft Decline retry mechanism will not be skipped for this transaction. Note: skipSoftDecline defaults to false if empty. This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.

withSkipSoftDecline

public ThreeDSecure withSkipSoftDecline(Boolean value)

* true = Soft Decline retry mechanism will be skipped for this transaction. The transaction will result in "Authorization Declined" status. This setting should be used when skipAuthentication is set to true and the merchant does not want to use Soft Decline retry mechanism. * false = Soft Decline retry mechanism will not be skipped for this transaction. Note: skipSoftDecline defaults to false if empty. This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.