Package com.adyen.model.payment
Class PaymentRequest3ds2
- java.lang.Object
-
- com.adyen.model.payment.PaymentRequest3ds2
-
public class PaymentRequest3ds2 extends Object
PaymentRequest3ds2
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPaymentRequest3ds2.RecurringProcessingModelEnumDefines a recurring payment type.static classPaymentRequest3ds2.ShopperInteractionEnumSpecifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description PaymentRequest3ds2()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description PaymentRequest3ds2accountInfo(AccountInfo accountInfo)PaymentRequest3ds2additionalAmount(Amount additionalAmount)PaymentRequest3ds2additionalData(Map<String,String> additionalData)PaymentRequest3ds2addSplitsItem(Split splitsItem)PaymentRequest3ds2amount(Amount amount)PaymentRequest3ds2applicationInfo(ApplicationInfo applicationInfo)PaymentRequest3ds2billingAddress(Address billingAddress)PaymentRequest3ds2browserInfo(BrowserInfo browserInfo)PaymentRequest3ds2captureDelayHours(Integer captureDelayHours)PaymentRequest3ds2dateOfBirth(LocalDate dateOfBirth)PaymentRequest3ds2dccQuote(ForexQuote dccQuote)PaymentRequest3ds2deliveryAddress(Address deliveryAddress)PaymentRequest3ds2deliveryDate(OffsetDateTime deliveryDate)PaymentRequest3ds2deviceFingerprint(String deviceFingerprint)booleanequals(Object o)Return true if this PaymentRequest3ds2 object is equal to o.PaymentRequest3ds2fraudOffset(Integer fraudOffset)static PaymentRequest3ds2fromJson(String jsonString)Create an instance of PaymentRequest3ds2 given an JSON stringAccountInfogetAccountInfo()Get accountInfoAmountgetAdditionalAmount()Get additionalAmountMap<String,String>getAdditionalData()This field contains additional data, which may be required for a particular payment request.AmountgetAmount()Get amountApplicationInfogetApplicationInfo()Get applicationInfoAddressgetBillingAddress()Get billingAddressBrowserInfogetBrowserInfo()Get browserInfoIntegergetCaptureDelayHours()The delay between the authorisation and scheduled auto-capture, specified in hours.LocalDategetDateOfBirth()The shopper's date of birth.ForexQuotegetDccQuote()Get dccQuoteAddressgetDeliveryAddress()Get deliveryAddressOffsetDateTimegetDeliveryDate()The date and time the purchased goods should be delivered.StringgetDeviceFingerprint()A string containing the shopper's device fingerprint.IntegergetFraudOffset()An integer value that is added to the normal fraud score.InstallmentsgetInstallments()Get installmentsMap<String,String>getLocalizedShopperStatement()The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.StringgetMcc()The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment.StringgetMerchantAccount()The merchant account identifier, with which you want to process the transaction.StringgetMerchantOrderReference()This reference allows linking multiple transactions to each other for reporting purposes (i.e.MerchantRiskIndicatorgetMerchantRiskIndicator()Get merchantRiskIndicatorMap<String,String>getMetadata()Metadata consists of entries, each of which includes a key and a value.StringgetOrderReference()When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.RecurringgetRecurring()Get recurringPaymentRequest3ds2.RecurringProcessingModelEnumgetRecurringProcessingModel()Defines a recurring payment type.StringgetReference()The reference to uniquely identify a payment.StringgetSelectedBrand()Some payment methods require defining a value for this field to specify how to process the transaction.StringgetSelectedRecurringDetailReference()The `recurringDetailReference` you want to use for this payment.StringgetSessionId()A session ID used to identify a payment session.StringgetShopperEmail()The shopper's email address.PaymentRequest3ds2.ShopperInteractionEnumgetShopperInteraction()Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.StringgetShopperIP()The shopper's IP address.StringgetShopperLocale()The combination of a language code and a country code to specify the language to be used in the payment.NamegetShopperName()Get shopperNameStringgetShopperReference()Required for recurring payments.StringgetShopperStatement()The text to be shown on the shopper's bank statement.StringgetSocialSecurityNumber()The shopper's social security number.List<Split>getSplits()An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).StringgetStore()Required for Adyen for Platforms integrations if you are a platform model.StringgetTelephoneNumber()The shopper's telephone number.ThreeDS2RequestDatagetThreeDS2RequestData()Get threeDS2RequestDataThreeDS2ResultgetThreeDS2Result()Get threeDS2ResultStringgetThreeDS2Token()The ThreeDS2Token that was returned in the /authorise call.BooleangetThreeDSAuthenticationOnly()If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.StringgetTotalsGroup()The reference value to aggregate sales totals in reporting.BooleangetTrustedShopper()Set to true if the payment should be routed to a trusted MID.inthashCode()PaymentRequest3ds2installments(Installments installments)PaymentRequest3ds2localizedShopperStatement(Map<String,String> localizedShopperStatement)PaymentRequest3ds2mcc(String mcc)PaymentRequest3ds2merchantAccount(String merchantAccount)PaymentRequest3ds2merchantOrderReference(String merchantOrderReference)PaymentRequest3ds2merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)PaymentRequest3ds2metadata(Map<String,String> metadata)PaymentRequest3ds2orderReference(String orderReference)PaymentRequest3ds2putAdditionalDataItem(String key, String additionalDataItem)PaymentRequest3ds2putLocalizedShopperStatementItem(String key, String localizedShopperStatementItem)PaymentRequest3ds2putMetadataItem(String key, String metadataItem)PaymentRequest3ds2recurring(Recurring recurring)PaymentRequest3ds2recurringProcessingModel(PaymentRequest3ds2.RecurringProcessingModelEnum recurringProcessingModel)PaymentRequest3ds2reference(String reference)PaymentRequest3ds2selectedBrand(String selectedBrand)PaymentRequest3ds2selectedRecurringDetailReference(String selectedRecurringDetailReference)PaymentRequest3ds2sessionId(String sessionId)voidsetAccountInfo(AccountInfo accountInfo)accountInfovoidsetAdditionalAmount(Amount additionalAmount)additionalAmountvoidsetAdditionalData(Map<String,String> additionalData)This field contains additional data, which may be required for a particular payment request.voidsetAmount(Amount amount)amountvoidsetApplicationInfo(ApplicationInfo applicationInfo)applicationInfovoidsetBillingAddress(Address billingAddress)billingAddressvoidsetBrowserInfo(BrowserInfo browserInfo)browserInfovoidsetCaptureDelayHours(Integer captureDelayHours)The delay between the authorisation and scheduled auto-capture, specified in hours.voidsetDateOfBirth(LocalDate dateOfBirth)The shopper's date of birth.voidsetDccQuote(ForexQuote dccQuote)dccQuotevoidsetDeliveryAddress(Address deliveryAddress)deliveryAddressvoidsetDeliveryDate(OffsetDateTime deliveryDate)The date and time the purchased goods should be delivered.voidsetDeviceFingerprint(String deviceFingerprint)A string containing the shopper's device fingerprint.voidsetFraudOffset(Integer fraudOffset)An integer value that is added to the normal fraud score.voidsetInstallments(Installments installments)installmentsvoidsetLocalizedShopperStatement(Map<String,String> localizedShopperStatement)The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.voidsetMcc(String mcc)The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment.voidsetMerchantAccount(String merchantAccount)The merchant account identifier, with which you want to process the transaction.voidsetMerchantOrderReference(String merchantOrderReference)This reference allows linking multiple transactions to each other for reporting purposes (i.e.voidsetMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)merchantRiskIndicatorvoidsetMetadata(Map<String,String> metadata)Metadata consists of entries, each of which includes a key and a value.voidsetOrderReference(String orderReference)When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.voidsetRecurring(Recurring recurring)recurringvoidsetRecurringProcessingModel(PaymentRequest3ds2.RecurringProcessingModelEnum recurringProcessingModel)Defines a recurring payment type.voidsetReference(String reference)The reference to uniquely identify a payment.voidsetSelectedBrand(String selectedBrand)Some payment methods require defining a value for this field to specify how to process the transaction.voidsetSelectedRecurringDetailReference(String selectedRecurringDetailReference)The `recurringDetailReference` you want to use for this payment.voidsetSessionId(String sessionId)A session ID used to identify a payment session.voidsetShopperEmail(String shopperEmail)The shopper's email address.voidsetShopperInteraction(PaymentRequest3ds2.ShopperInteractionEnum shopperInteraction)Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.voidsetShopperIP(String shopperIP)The shopper's IP address.voidsetShopperLocale(String shopperLocale)The combination of a language code and a country code to specify the language to be used in the payment.voidsetShopperName(Name shopperName)shopperNamevoidsetShopperReference(String shopperReference)Required for recurring payments.voidsetShopperStatement(String shopperStatement)The text to be shown on the shopper's bank statement.voidsetSocialSecurityNumber(String socialSecurityNumber)The shopper's social security number.voidsetSplits(List<Split> splits)An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).voidsetStore(String store)Required for Adyen for Platforms integrations if you are a platform model.voidsetTelephoneNumber(String telephoneNumber)The shopper's telephone number.voidsetThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)threeDS2RequestDatavoidsetThreeDS2Result(ThreeDS2Result threeDS2Result)threeDS2ResultvoidsetThreeDS2Token(String threeDS2Token)The ThreeDS2Token that was returned in the /authorise call.voidsetThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.voidsetTotalsGroup(String totalsGroup)The reference value to aggregate sales totals in reporting.voidsetTrustedShopper(Boolean trustedShopper)Set to true if the payment should be routed to a trusted MID.PaymentRequest3ds2shopperEmail(String shopperEmail)PaymentRequest3ds2shopperInteraction(PaymentRequest3ds2.ShopperInteractionEnum shopperInteraction)PaymentRequest3ds2shopperIP(String shopperIP)PaymentRequest3ds2shopperLocale(String shopperLocale)PaymentRequest3ds2shopperName(Name shopperName)PaymentRequest3ds2shopperReference(String shopperReference)PaymentRequest3ds2shopperStatement(String shopperStatement)PaymentRequest3ds2socialSecurityNumber(String socialSecurityNumber)PaymentRequest3ds2splits(List<Split> splits)PaymentRequest3ds2store(String store)PaymentRequest3ds2telephoneNumber(String telephoneNumber)PaymentRequest3ds2threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)PaymentRequest3ds2threeDS2Result(ThreeDS2Result threeDS2Result)PaymentRequest3ds2threeDS2Token(String threeDS2Token)PaymentRequest3ds2threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)StringtoJson()Convert an instance of PaymentRequest3ds2 to an JSON stringStringtoString()PaymentRequest3ds2totalsGroup(String totalsGroup)PaymentRequest3ds2trustedShopper(Boolean trustedShopper)
-
-
-
Field Detail
-
JSON_PROPERTY_ACCOUNT_INFO
public static final String JSON_PROPERTY_ACCOUNT_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDITIONAL_AMOUNT
public static final String JSON_PROPERTY_ADDITIONAL_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDITIONAL_DATA
public static final String JSON_PROPERTY_ADDITIONAL_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_APPLICATION_INFO
public static final String JSON_PROPERTY_APPLICATION_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BILLING_ADDRESS
public static final String JSON_PROPERTY_BILLING_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BROWSER_INFO
public static final String JSON_PROPERTY_BROWSER_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAPTURE_DELAY_HOURS
public static final String JSON_PROPERTY_CAPTURE_DELAY_HOURS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DATE_OF_BIRTH
public static final String JSON_PROPERTY_DATE_OF_BIRTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DCC_QUOTE
public static final String JSON_PROPERTY_DCC_QUOTE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DELIVERY_ADDRESS
public static final String JSON_PROPERTY_DELIVERY_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DELIVERY_DATE
public static final String JSON_PROPERTY_DELIVERY_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DEVICE_FINGERPRINT
public static final String JSON_PROPERTY_DEVICE_FINGERPRINT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FRAUD_OFFSET
public static final String JSON_PROPERTY_FRAUD_OFFSET
- See Also:
- Constant Field Values
-
JSON_PROPERTY_INSTALLMENTS
public static final String JSON_PROPERTY_INSTALLMENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT
public static final String JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MCC
public static final String JSON_PROPERTY_MCC
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ACCOUNT
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
public static final String JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_RISK_INDICATOR
public static final String JSON_PROPERTY_MERCHANT_RISK_INDICATOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_METADATA
public static final String JSON_PROPERTY_METADATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORDER_REFERENCE
public static final String JSON_PROPERTY_ORDER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING
public static final String JSON_PROPERTY_RECURRING
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_PROCESSING_MODEL
public static final String JSON_PROPERTY_RECURRING_PROCESSING_MODEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SELECTED_BRAND
public static final String JSON_PROPERTY_SELECTED_BRAND
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
public static final String JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SESSION_ID
public static final String JSON_PROPERTY_SESSION_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_EMAIL
public static final String JSON_PROPERTY_SHOPPER_EMAIL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_I_P
public static final String JSON_PROPERTY_SHOPPER_I_P
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_INTERACTION
public static final String JSON_PROPERTY_SHOPPER_INTERACTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_LOCALE
public static final String JSON_PROPERTY_SHOPPER_LOCALE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_NAME
public static final String JSON_PROPERTY_SHOPPER_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_REFERENCE
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_STATEMENT
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SPLITS
public static final String JSON_PROPERTY_SPLITS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE
public static final String JSON_PROPERTY_STORE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TELEPHONE_NUMBER
public static final String JSON_PROPERTY_TELEPHONE_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
public static final String JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S2_RESULT
public static final String JSON_PROPERTY_THREE_D_S2_RESULT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S2_TOKEN
public static final String JSON_PROPERTY_THREE_D_S2_TOKEN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
public static final String JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TOTALS_GROUP
public static final String JSON_PROPERTY_TOTALS_GROUP
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRUSTED_SHOPPER
public static final String JSON_PROPERTY_TRUSTED_SHOPPER
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountInfo
public PaymentRequest3ds2 accountInfo(AccountInfo accountInfo)
-
getAccountInfo
public AccountInfo getAccountInfo()
Get accountInfo- Returns:
- accountInfo
-
setAccountInfo
public void setAccountInfo(AccountInfo accountInfo)
accountInfo- Parameters:
accountInfo-
-
additionalAmount
public PaymentRequest3ds2 additionalAmount(Amount additionalAmount)
-
getAdditionalAmount
public Amount getAdditionalAmount()
Get additionalAmount- Returns:
- additionalAmount
-
setAdditionalAmount
public void setAdditionalAmount(Amount additionalAmount)
additionalAmount- Parameters:
additionalAmount-
-
additionalData
public PaymentRequest3ds2 additionalData(Map<String,String> additionalData)
-
putAdditionalDataItem
public PaymentRequest3ds2 putAdditionalDataItem(String key, String additionalDataItem)
-
getAdditionalData
public Map<String,String> getAdditionalData()
This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.- Returns:
- additionalData
-
setAdditionalData
public void setAdditionalData(Map<String,String> additionalData)
This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.- Parameters:
additionalData-
-
amount
public PaymentRequest3ds2 amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
amount- Parameters:
amount-
-
applicationInfo
public PaymentRequest3ds2 applicationInfo(ApplicationInfo applicationInfo)
-
getApplicationInfo
public ApplicationInfo getApplicationInfo()
Get applicationInfo- Returns:
- applicationInfo
-
setApplicationInfo
public void setApplicationInfo(ApplicationInfo applicationInfo)
applicationInfo- Parameters:
applicationInfo-
-
billingAddress
public PaymentRequest3ds2 billingAddress(Address billingAddress)
-
getBillingAddress
public Address getBillingAddress()
Get billingAddress- Returns:
- billingAddress
-
setBillingAddress
public void setBillingAddress(Address billingAddress)
billingAddress- Parameters:
billingAddress-
-
browserInfo
public PaymentRequest3ds2 browserInfo(BrowserInfo browserInfo)
-
getBrowserInfo
public BrowserInfo getBrowserInfo()
Get browserInfo- Returns:
- browserInfo
-
setBrowserInfo
public void setBrowserInfo(BrowserInfo browserInfo)
browserInfo- Parameters:
browserInfo-
-
captureDelayHours
public PaymentRequest3ds2 captureDelayHours(Integer captureDelayHours)
-
getCaptureDelayHours
public Integer getCaptureDelayHours()
The delay between the authorisation and scheduled auto-capture, specified in hours.- Returns:
- captureDelayHours
-
setCaptureDelayHours
public void setCaptureDelayHours(Integer captureDelayHours)
The delay between the authorisation and scheduled auto-capture, specified in hours.- Parameters:
captureDelayHours-
-
dateOfBirth
public PaymentRequest3ds2 dateOfBirth(LocalDate dateOfBirth)
-
getDateOfBirth
public LocalDate getDateOfBirth()
The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD- Returns:
- dateOfBirth
-
setDateOfBirth
public void setDateOfBirth(LocalDate dateOfBirth)
The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD- Parameters:
dateOfBirth-
-
dccQuote
public PaymentRequest3ds2 dccQuote(ForexQuote dccQuote)
-
getDccQuote
public ForexQuote getDccQuote()
Get dccQuote- Returns:
- dccQuote
-
setDccQuote
public void setDccQuote(ForexQuote dccQuote)
dccQuote- Parameters:
dccQuote-
-
deliveryAddress
public PaymentRequest3ds2 deliveryAddress(Address deliveryAddress)
-
getDeliveryAddress
public Address getDeliveryAddress()
Get deliveryAddress- Returns:
- deliveryAddress
-
setDeliveryAddress
public void setDeliveryAddress(Address deliveryAddress)
deliveryAddress- Parameters:
deliveryAddress-
-
deliveryDate
public PaymentRequest3ds2 deliveryDate(OffsetDateTime deliveryDate)
-
getDeliveryDate
public OffsetDateTime getDeliveryDate()
The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00- Returns:
- deliveryDate
-
setDeliveryDate
public void setDeliveryDate(OffsetDateTime deliveryDate)
The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00- Parameters:
deliveryDate-
-
deviceFingerprint
public PaymentRequest3ds2 deviceFingerprint(String deviceFingerprint)
-
getDeviceFingerprint
public String getDeviceFingerprint()
A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).- Returns:
- deviceFingerprint
-
setDeviceFingerprint
public void setDeviceFingerprint(String deviceFingerprint)
A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).- Parameters:
deviceFingerprint-
-
fraudOffset
public PaymentRequest3ds2 fraudOffset(Integer fraudOffset)
-
getFraudOffset
public Integer getFraudOffset()
An integer value that is added to the normal fraud score. The value can be either positive or negative.- Returns:
- fraudOffset
-
setFraudOffset
public void setFraudOffset(Integer fraudOffset)
An integer value that is added to the normal fraud score. The value can be either positive or negative.- Parameters:
fraudOffset-
-
installments
public PaymentRequest3ds2 installments(Installments installments)
-
getInstallments
public Installments getInstallments()
Get installments- Returns:
- installments
-
setInstallments
public void setInstallments(Installments installments)
installments- Parameters:
installments-
-
localizedShopperStatement
public PaymentRequest3ds2 localizedShopperStatement(Map<String,String> localizedShopperStatement)
-
putLocalizedShopperStatementItem
public PaymentRequest3ds2 putLocalizedShopperStatementItem(String key, String localizedShopperStatementItem)
-
getLocalizedShopperStatement
public Map<String,String> getLocalizedShopperStatement()
The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters.- Returns:
- localizedShopperStatement
-
setLocalizedShopperStatement
public void setLocalizedShopperStatement(Map<String,String> localizedShopperStatement)
The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters.- Parameters:
localizedShopperStatement-
-
mcc
public PaymentRequest3ds2 mcc(String mcc)
-
getMcc
public String getMcc()
The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.- Returns:
- mcc
-
setMcc
public void setMcc(String mcc)
The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.- Parameters:
mcc-
-
merchantAccount
public PaymentRequest3ds2 merchantAccount(String merchantAccount)
-
getMerchantAccount
public String getMerchantAccount()
The merchant account identifier, with which you want to process the transaction.- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
The merchant account identifier, with which you want to process the transaction.- Parameters:
merchantAccount-
-
merchantOrderReference
public PaymentRequest3ds2 merchantOrderReference(String merchantOrderReference)
-
getMerchantOrderReference
public String getMerchantOrderReference()
This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.- Returns:
- merchantOrderReference
-
setMerchantOrderReference
public void setMerchantOrderReference(String merchantOrderReference)
This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.- Parameters:
merchantOrderReference-
-
merchantRiskIndicator
public PaymentRequest3ds2 merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
-
getMerchantRiskIndicator
public MerchantRiskIndicator getMerchantRiskIndicator()
Get merchantRiskIndicator- Returns:
- merchantRiskIndicator
-
setMerchantRiskIndicator
public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
merchantRiskIndicator- Parameters:
merchantRiskIndicator-
-
metadata
public PaymentRequest3ds2 metadata(Map<String,String> metadata)
-
putMetadataItem
public PaymentRequest3ds2 putMetadataItem(String key, String metadataItem)
-
getMetadata
public Map<String,String> getMetadata()
Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value.- Returns:
- metadata
-
setMetadata
public void setMetadata(Map<String,String> metadata)
Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value.- Parameters:
metadata-
-
orderReference
public PaymentRequest3ds2 orderReference(String orderReference)
-
getOrderReference
public String getOrderReference()
When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.- Returns:
- orderReference
-
setOrderReference
public void setOrderReference(String orderReference)
When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.- Parameters:
orderReference-
-
recurring
public PaymentRequest3ds2 recurring(Recurring recurring)
-
getRecurring
public Recurring getRecurring()
Get recurring- Returns:
- recurring
-
setRecurring
public void setRecurring(Recurring recurring)
recurring- Parameters:
recurring-
-
recurringProcessingModel
public PaymentRequest3ds2 recurringProcessingModel(PaymentRequest3ds2.RecurringProcessingModelEnum recurringProcessingModel)
-
getRecurringProcessingModel
public PaymentRequest3ds2.RecurringProcessingModelEnum getRecurringProcessingModel()
Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.- Returns:
- recurringProcessingModel
-
setRecurringProcessingModel
public void setRecurringProcessingModel(PaymentRequest3ds2.RecurringProcessingModelEnum recurringProcessingModel)
Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.- Parameters:
recurringProcessingModel-
-
reference
public PaymentRequest3ds2 reference(String reference)
-
getReference
public String getReference()
The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.- Returns:
- reference
-
setReference
public void setReference(String reference)
The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.- Parameters:
reference-
-
selectedBrand
public PaymentRequest3ds2 selectedBrand(String selectedBrand)
-
getSelectedBrand
public String getSelectedBrand()
Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card.- Returns:
- selectedBrand
-
setSelectedBrand
public void setSelectedBrand(String selectedBrand)
Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card.- Parameters:
selectedBrand-
-
selectedRecurringDetailReference
public PaymentRequest3ds2 selectedRecurringDetailReference(String selectedRecurringDetailReference)
-
getSelectedRecurringDetailReference
public String getSelectedRecurringDetailReference()
The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.- Returns:
- selectedRecurringDetailReference
-
setSelectedRecurringDetailReference
public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.- Parameters:
selectedRecurringDetailReference-
-
sessionId
public PaymentRequest3ds2 sessionId(String sessionId)
-
getSessionId
public String getSessionId()
A session ID used to identify a payment session.- Returns:
- sessionId
-
setSessionId
public void setSessionId(String sessionId)
A session ID used to identify a payment session.- Parameters:
sessionId-
-
shopperEmail
public PaymentRequest3ds2 shopperEmail(String shopperEmail)
-
getShopperEmail
public String getShopperEmail()
The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.- Returns:
- shopperEmail
-
setShopperEmail
public void setShopperEmail(String shopperEmail)
The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.- Parameters:
shopperEmail-
-
shopperIP
public PaymentRequest3ds2 shopperIP(String shopperIP)
-
getShopperIP
public String getShopperIP()
The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).- Returns:
- shopperIP
-
setShopperIP
public void setShopperIP(String shopperIP)
The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).- Parameters:
shopperIP-
-
shopperInteraction
public PaymentRequest3ds2 shopperInteraction(PaymentRequest3ds2.ShopperInteractionEnum shopperInteraction)
-
getShopperInteraction
public PaymentRequest3ds2.ShopperInteractionEnum getShopperInteraction()
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.- Returns:
- shopperInteraction
-
setShopperInteraction
public void setShopperInteraction(PaymentRequest3ds2.ShopperInteractionEnum shopperInteraction)
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.- Parameters:
shopperInteraction-
-
shopperLocale
public PaymentRequest3ds2 shopperLocale(String shopperLocale)
-
getShopperLocale
public String getShopperLocale()
The combination of a language code and a country code to specify the language to be used in the payment.- Returns:
- shopperLocale
-
setShopperLocale
public void setShopperLocale(String shopperLocale)
The combination of a language code and a country code to specify the language to be used in the payment.- Parameters:
shopperLocale-
-
shopperName
public PaymentRequest3ds2 shopperName(Name shopperName)
-
getShopperName
public Name getShopperName()
Get shopperName- Returns:
- shopperName
-
setShopperName
public void setShopperName(Name shopperName)
shopperName- Parameters:
shopperName-
-
shopperReference
public PaymentRequest3ds2 shopperReference(String shopperReference)
-
getShopperReference
public String getShopperReference()
Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.- Returns:
- shopperReference
-
setShopperReference
public void setShopperReference(String shopperReference)
Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.- Parameters:
shopperReference-
-
shopperStatement
public PaymentRequest3ds2 shopperStatement(String shopperStatement)
-
getShopperStatement
public String getShopperStatement()
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.- Returns:
- shopperStatement
-
setShopperStatement
public void setShopperStatement(String shopperStatement)
The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.- Parameters:
shopperStatement-
-
socialSecurityNumber
public PaymentRequest3ds2 socialSecurityNumber(String socialSecurityNumber)
-
getSocialSecurityNumber
public String getSocialSecurityNumber()
The shopper's social security number.- Returns:
- socialSecurityNumber
-
setSocialSecurityNumber
public void setSocialSecurityNumber(String socialSecurityNumber)
The shopper's social security number.- Parameters:
socialSecurityNumber-
-
splits
public PaymentRequest3ds2 splits(List<Split> splits)
-
addSplitsItem
public PaymentRequest3ds2 addSplitsItem(Split splitsItem)
-
getSplits
public List<Split> getSplits()
An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).- Returns:
- splits
-
setSplits
public void setSplits(List<Split> splits)
An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).- Parameters:
splits-
-
store
public PaymentRequest3ds2 store(String store)
-
getStore
public String getStore()
Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.- Returns:
- store
-
setStore
public void setStore(String store)
Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.- Parameters:
store-
-
telephoneNumber
public PaymentRequest3ds2 telephoneNumber(String telephoneNumber)
-
getTelephoneNumber
public String getTelephoneNumber()
The shopper's telephone number.- Returns:
- telephoneNumber
-
setTelephoneNumber
public void setTelephoneNumber(String telephoneNumber)
The shopper's telephone number.- Parameters:
telephoneNumber-
-
threeDS2RequestData
public PaymentRequest3ds2 threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
-
getThreeDS2RequestData
public ThreeDS2RequestData getThreeDS2RequestData()
Get threeDS2RequestData- Returns:
- threeDS2RequestData
-
setThreeDS2RequestData
public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
threeDS2RequestData- Parameters:
threeDS2RequestData-
-
threeDS2Result
public PaymentRequest3ds2 threeDS2Result(ThreeDS2Result threeDS2Result)
-
getThreeDS2Result
public ThreeDS2Result getThreeDS2Result()
Get threeDS2Result- Returns:
- threeDS2Result
-
setThreeDS2Result
public void setThreeDS2Result(ThreeDS2Result threeDS2Result)
threeDS2Result- Parameters:
threeDS2Result-
-
threeDS2Token
public PaymentRequest3ds2 threeDS2Token(String threeDS2Token)
-
getThreeDS2Token
public String getThreeDS2Token()
The ThreeDS2Token that was returned in the /authorise call.- Returns:
- threeDS2Token
-
setThreeDS2Token
public void setThreeDS2Token(String threeDS2Token)
The ThreeDS2Token that was returned in the /authorise call.- Parameters:
threeDS2Token-
-
threeDSAuthenticationOnly
public PaymentRequest3ds2 threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
-
getThreeDSAuthenticationOnly
public Boolean getThreeDSAuthenticationOnly()
If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.- Returns:
- threeDSAuthenticationOnly
-
setThreeDSAuthenticationOnly
public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.- Parameters:
threeDSAuthenticationOnly-
-
totalsGroup
public PaymentRequest3ds2 totalsGroup(String totalsGroup)
-
getTotalsGroup
public String getTotalsGroup()
The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).- Returns:
- totalsGroup
-
setTotalsGroup
public void setTotalsGroup(String totalsGroup)
The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).- Parameters:
totalsGroup-
-
trustedShopper
public PaymentRequest3ds2 trustedShopper(Boolean trustedShopper)
-
getTrustedShopper
public Boolean getTrustedShopper()
Set to true if the payment should be routed to a trusted MID.- Returns:
- trustedShopper
-
setTrustedShopper
public void setTrustedShopper(Boolean trustedShopper)
Set to true if the payment should be routed to a trusted MID.- Parameters:
trustedShopper-
-
equals
public boolean equals(Object o)
Return true if this PaymentRequest3ds2 object is equal to o.
-
fromJson
public static PaymentRequest3ds2 fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of PaymentRequest3ds2 given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of PaymentRequest3ds2
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to PaymentRequest3ds2
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of PaymentRequest3ds2 to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-