java.lang.Object
- com.adyen.model.checkout.PaymentSetupRequest

public class PaymentSetupRequest
extends Object

PaymentSetupRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PaymentSetupRequest.ChannelEnum`	The platform where a payment transaction takes place.
`static class`	`PaymentSetupRequest.EntityTypeEnum`	The type of the entity the payment is processed for.
`static class`	`PaymentSetupRequest.ShopperInteractionEnum`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ADDITIONAL_AMOUNT`
`static String`	`JSON_PROPERTY_ADDITIONAL_DATA`
`static String`	`JSON_PROPERTY_ALLOWED_PAYMENT_METHODS`
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_APPLICATION_INFO`
`static String`	`JSON_PROPERTY_BILLING_ADDRESS`
`static String`	`JSON_PROPERTY_BLOCKED_PAYMENT_METHODS`
`static String`	`JSON_PROPERTY_CAPTURE_DELAY_HOURS`
`static String`	`JSON_PROPERTY_CHANNEL`
`static String`	`JSON_PROPERTY_CHECKOUT_ATTEMPT_ID`
`static String`	`JSON_PROPERTY_COMPANY`
`static String`	`JSON_PROPERTY_CONFIGURATION`
`static String`	`JSON_PROPERTY_CONVERSION_ID`
`static String`	`JSON_PROPERTY_COUNTRY_CODE`
`static String`	`JSON_PROPERTY_DATE_OF_BIRTH`
`static String`	`JSON_PROPERTY_DCC_QUOTE`
`static String`	`JSON_PROPERTY_DELIVERY_ADDRESS`
`static String`	`JSON_PROPERTY_DELIVERY_DATE`
`static String`	`JSON_PROPERTY_ENABLE_ONE_CLICK`
`static String`	`JSON_PROPERTY_ENABLE_PAY_OUT`
`static String`	`JSON_PROPERTY_ENABLE_RECURRING`
`static String`	`JSON_PROPERTY_ENTITY_TYPE`
`static String`	`JSON_PROPERTY_FRAUD_OFFSET`
`static String`	`JSON_PROPERTY_INSTALLMENTS`
`static String`	`JSON_PROPERTY_LINE_ITEMS`
`static String`	`JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT`
`static String`	`JSON_PROPERTY_MANDATE`
`static String`	`JSON_PROPERTY_MCC`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_MERCHANT_ORDER_REFERENCE`
`static String`	`JSON_PROPERTY_METADATA`
`static String`	`JSON_PROPERTY_ORDER_REFERENCE`
`static String`	`JSON_PROPERTY_ORIGIN`
`static String`	`JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC`
`static String`	`JSON_PROPERTY_RECURRING_EXPIRY`
`static String`	`JSON_PROPERTY_RECURRING_FREQUENCY`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_RETURN_URL`
`static String`	`JSON_PROPERTY_RISK_DATA`
`static String`	`JSON_PROPERTY_SDK_VERSION`
`static String`	`JSON_PROPERTY_SECURE_REMOTE_COMMERCE_CHECKOUT_DATA`
`static String`	`JSON_PROPERTY_SESSION_VALIDITY`
`static String`	`JSON_PROPERTY_SHOPPER_EMAIL`
`static String`	`JSON_PROPERTY_SHOPPER_I_P`
`static String`	`JSON_PROPERTY_SHOPPER_INTERACTION`
`static String`	`JSON_PROPERTY_SHOPPER_LOCALE`
`static String`	`JSON_PROPERTY_SHOPPER_NAME`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_SHOPPER_STATEMENT`
`static String`	`JSON_PROPERTY_SOCIAL_SECURITY_NUMBER`
`static String`	`JSON_PROPERTY_SPLITS`
`static String`	`JSON_PROPERTY_STORE`
`static String`	`JSON_PROPERTY_STORE_PAYMENT_METHOD`
`static String`	`JSON_PROPERTY_TELEPHONE_NUMBER`
`static String`	`JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY`
`static String`	`JSON_PROPERTY_TOKEN`
`static String`	`JSON_PROPERTY_TRUSTED_SHOPPER`

Constructor Summary

Constructors
Constructor Description

PaymentSetupRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`PaymentSetupRequest`	`addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)`
`PaymentSetupRequest`	`addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)`
`PaymentSetupRequest`	`additionalAmount(Amount additionalAmount)`	additionalAmount
`PaymentSetupRequest`	`additionalData(Map<String,String> additionalData)`	This field contains additional data, which may be required for a particular payment request.
`PaymentSetupRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentSetupRequest`	`addSplitsItem(Split splitsItem)`
`PaymentSetupRequest`	`allowedPaymentMethods(List<String> allowedPaymentMethods)`	List of payment methods to be presented to the shopper.
`PaymentSetupRequest`	`amount(Amount amount)`	amount
`PaymentSetupRequest`	`applicationInfo(ApplicationInfo applicationInfo)`	applicationInfo
`PaymentSetupRequest`	`billingAddress(Address billingAddress)`	billingAddress
`PaymentSetupRequest`	`blockedPaymentMethods(List<String> blockedPaymentMethods)`	List of payment methods to be hidden from the shopper.
`PaymentSetupRequest`	`captureDelayHours(Integer captureDelayHours)`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`PaymentSetupRequest`	`channel(PaymentSetupRequest.ChannelEnum channel)`	The platform where a payment transaction takes place.
`PaymentSetupRequest`	`checkoutAttemptId(String checkoutAttemptId)`	Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
`PaymentSetupRequest`	`company(Company company)`	company
`PaymentSetupRequest`	`configuration(ModelConfiguration configuration)`	configuration
`PaymentSetupRequest`	`conversionId(String conversionId)`	Deprecated. since Adyen Checkout API v68 Use `checkoutAttemptId` instead
`PaymentSetupRequest`	`countryCode(String countryCode)`	The shopper country.
`PaymentSetupRequest`	`dateOfBirth(LocalDate dateOfBirth)`	The shopper's date of birth.
`PaymentSetupRequest`	`dccQuote(ForexQuote dccQuote)`	dccQuote
`PaymentSetupRequest`	`deliveryAddress(Address deliveryAddress)`	deliveryAddress
`PaymentSetupRequest`	`deliveryDate(OffsetDateTime deliveryDate)`	The date and time the purchased goods should be delivered.
`PaymentSetupRequest`	`enableOneClick(Boolean enableOneClick)`	When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
`PaymentSetupRequest`	`enablePayOut(Boolean enablePayOut)`	When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
`PaymentSetupRequest`	`enableRecurring(Boolean enableRecurring)`	When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
`PaymentSetupRequest`	`entityType(PaymentSetupRequest.EntityTypeEnum entityType)`	The type of the entity the payment is processed for.
`boolean`	`equals(Object o)`	Return true if this PaymentSetupRequest object is equal to o.
`PaymentSetupRequest`	`fraudOffset(Integer fraudOffset)`	An integer value that is added to the normal fraud score.
`static PaymentSetupRequest`	`fromJson(String jsonString)`	Create an instance of PaymentSetupRequest given an JSON string
`Amount`	`getAdditionalAmount()`	additionalAmount
`Map<String,String>`	`getAdditionalData()`	This field contains additional data, which may be required for a particular payment request.
`List<String>`	`getAllowedPaymentMethods()`	List of payment methods to be presented to the shopper.
`Amount`	`getAmount()`	amount
`ApplicationInfo`	`getApplicationInfo()`	applicationInfo
`Address`	`getBillingAddress()`	billingAddress
`List<String>`	`getBlockedPaymentMethods()`	List of payment methods to be hidden from the shopper.
`Integer`	`getCaptureDelayHours()`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`PaymentSetupRequest.ChannelEnum`	`getChannel()`	The platform where a payment transaction takes place.
`String`	`getCheckoutAttemptId()`	Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
`Company`	`getCompany()`	company
`ModelConfiguration`	`getConfiguration()`	configuration
`String`	`getConversionId()`	Deprecated. since Adyen Checkout API v68 Use `checkoutAttemptId` instead
`String`	`getCountryCode()`	The shopper country.
`LocalDate`	`getDateOfBirth()`	The shopper's date of birth.
`ForexQuote`	`getDccQuote()`	dccQuote
`Address`	`getDeliveryAddress()`	deliveryAddress
`OffsetDateTime`	`getDeliveryDate()`	The date and time the purchased goods should be delivered.
`Boolean`	`getEnableOneClick()`	When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
`Boolean`	`getEnablePayOut()`	When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
`Boolean`	`getEnableRecurring()`	When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
`PaymentSetupRequest.EntityTypeEnum`	`getEntityType()`	The type of the entity the payment is processed for.
`Integer`	`getFraudOffset()`	An integer value that is added to the normal fraud score.
`Installments`	`getInstallments()`	installments
`List<LineItem>`	`getLineItems()`	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
`Map<String,String>`	`getLocalizedShopperStatement()`	The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.
`Mandate`	`getMandate()`	mandate
`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.
`String`	`getMerchantAccount()`	The merchant account identifier, with which you want to process the transaction.
`String`	`getMerchantOrderReference()`	This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).
`Map<String,String>`	`getMetadata()`	Metadata consists of entries, each of which includes a key and a value.
`String`	`getOrderReference()`	When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
`String`	`getOrigin()`	Required for the Web integration.
`PlatformChargebackLogic`	`getPlatformChargebackLogic()`	platformChargebackLogic
`String`	`getRecurringExpiry()`	Date after which no further authorisations shall be performed.
`String`	`getRecurringFrequency()`	Minimum number of days between authorisations.
`String`	`getReference()`	The reference to uniquely identify a payment.
`String`	`getReturnUrl()`	The URL to return to in case of a redirection.
`RiskData`	`getRiskData()`	riskData
`String`	`getSdkVersion()`	The version of the SDK you are using (for Web SDK integrations only).
`SecureRemoteCommerceCheckoutData`	`getSecureRemoteCommerceCheckoutData()`	secureRemoteCommerceCheckoutData
`String`	`getSessionValidity()`	The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
`String`	`getShopperEmail()`	The shopper's email address.
`PaymentSetupRequest.ShopperInteractionEnum`	`getShopperInteraction()`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`String`	`getShopperIP()`	The shopper's IP address.
`String`	`getShopperLocale()`	The combination of a language code and a country code to specify the language to be used in the payment.
`Name`	`getShopperName()`	shopperName
`String`	`getShopperReference()`	Required for recurring payments.
`String`	`getShopperStatement()`	The text to be shown on the shopper's bank statement.
`String`	`getSocialSecurityNumber()`	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).
`String`	`getStore()`	Required for Adyen for Platforms integrations if you are a platform model.
`Boolean`	`getStorePaymentMethod()`	When true and `shopperReference` is provided, the payment details will be stored.
`String`	`getTelephoneNumber()`	The shopper's telephone number.
`Boolean`	`getThreeDSAuthenticationOnly()`	Deprecated. since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
`String`	`getToken()`	The token obtained when initializing the SDK.
`Boolean`	`getTrustedShopper()`	Set to true if the payment should be routed to a trusted MID.
`int`	`hashCode()`
`PaymentSetupRequest`	`installments(Installments installments)`	installments
`PaymentSetupRequest`	`lineItems(List<LineItem> lineItems)`	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
`PaymentSetupRequest`	`localizedShopperStatement(Map<String,String> localizedShopperStatement)`	The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.
`PaymentSetupRequest`	`mandate(Mandate mandate)`	mandate
`PaymentSetupRequest`	`mcc(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.
`PaymentSetupRequest`	`merchantAccount(String merchantAccount)`	The merchant account identifier, with which you want to process the transaction.
`PaymentSetupRequest`	`merchantOrderReference(String merchantOrderReference)`	This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).
`PaymentSetupRequest`	`metadata(Map<String,String> metadata)`	Metadata consists of entries, each of which includes a key and a value.
`PaymentSetupRequest`	`orderReference(String orderReference)`	When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
`PaymentSetupRequest`	`origin(String origin)`	Required for the Web integration.
`PaymentSetupRequest`	`platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`	platformChargebackLogic
`PaymentSetupRequest`	`putAdditionalDataItem(String key, String additionalDataItem)`
`PaymentSetupRequest`	`putLocalizedShopperStatementItem(String key, String localizedShopperStatementItem)`
`PaymentSetupRequest`	`putMetadataItem(String key, String metadataItem)`
`PaymentSetupRequest`	`recurringExpiry(String recurringExpiry)`	Date after which no further authorisations shall be performed.
`PaymentSetupRequest`	`recurringFrequency(String recurringFrequency)`	Minimum number of days between authorisations.
`PaymentSetupRequest`	`reference(String reference)`	The reference to uniquely identify a payment.
`PaymentSetupRequest`	`returnUrl(String returnUrl)`	The URL to return to in case of a redirection.
`PaymentSetupRequest`	`riskData(RiskData riskData)`	riskData
`PaymentSetupRequest`	`sdkVersion(String sdkVersion)`	The version of the SDK you are using (for Web SDK integrations only).
`PaymentSetupRequest`	`secureRemoteCommerceCheckoutData(SecureRemoteCommerceCheckoutData secureRemoteCommerceCheckoutData)`	secureRemoteCommerceCheckoutData
`PaymentSetupRequest`	`sessionValidity(String sessionValidity)`	The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
`void`	`setAdditionalAmount(Amount additionalAmount)`	additionalAmount
`void`	`setAdditionalData(Map<String,String> additionalData)`	This field contains additional data, which may be required for a particular payment request.
`void`	`setAllowedPaymentMethods(List<String> allowedPaymentMethods)`	List of payment methods to be presented to the shopper.
`void`	`setAmount(Amount amount)`	amount
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`	applicationInfo
`void`	`setBillingAddress(Address billingAddress)`	billingAddress
`void`	`setBlockedPaymentMethods(List<String> blockedPaymentMethods)`	List of payment methods to be hidden from the shopper.
`void`	`setCaptureDelayHours(Integer captureDelayHours)`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`void`	`setChannel(PaymentSetupRequest.ChannelEnum channel)`	The platform where a payment transaction takes place.
`void`	`setCheckoutAttemptId(String checkoutAttemptId)`	Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
`void`	`setCompany(Company company)`	company
`void`	`setConfiguration(ModelConfiguration configuration)`	configuration
`void`	`setConversionId(String conversionId)`	Deprecated. since Adyen Checkout API v68 Use `checkoutAttemptId` instead
`void`	`setCountryCode(String countryCode)`	The shopper country.
`void`	`setDateOfBirth(LocalDate dateOfBirth)`	The shopper's date of birth.
`void`	`setDccQuote(ForexQuote dccQuote)`	dccQuote
`void`	`setDeliveryAddress(Address deliveryAddress)`	deliveryAddress
`void`	`setDeliveryDate(OffsetDateTime deliveryDate)`	The date and time the purchased goods should be delivered.
`void`	`setEnableOneClick(Boolean enableOneClick)`	When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
`void`	`setEnablePayOut(Boolean enablePayOut)`	When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
`void`	`setEnableRecurring(Boolean enableRecurring)`	When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
`void`	`setEntityType(PaymentSetupRequest.EntityTypeEnum entityType)`	The type of the entity the payment is processed for.
`void`	`setFraudOffset(Integer fraudOffset)`	An integer value that is added to the normal fraud score.
`void`	`setInstallments(Installments installments)`	installments
`void`	`setLineItems(List<LineItem> lineItems)`	Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
`void`	`setLocalizedShopperStatement(Map<String,String> localizedShopperStatement)`	The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.
`void`	`setMandate(Mandate mandate)`	mandate
`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.
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account identifier, with which you want to process the transaction.
`void`	`setMerchantOrderReference(String merchantOrderReference)`	This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).
`void`	`setMetadata(Map<String,String> metadata)`	Metadata consists of entries, each of which includes a key and a value.
`void`	`setOrderReference(String orderReference)`	When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
`void`	`setOrigin(String origin)`	Required for the Web integration.
`void`	`setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`	platformChargebackLogic
`void`	`setRecurringExpiry(String recurringExpiry)`	Date after which no further authorisations shall be performed.
`void`	`setRecurringFrequency(String recurringFrequency)`	Minimum number of days between authorisations.
`void`	`setReference(String reference)`	The reference to uniquely identify a payment.
`void`	`setReturnUrl(String returnUrl)`	The URL to return to in case of a redirection.
`void`	`setRiskData(RiskData riskData)`	riskData
`void`	`setSdkVersion(String sdkVersion)`	The version of the SDK you are using (for Web SDK integrations only).
`void`	`setSecureRemoteCommerceCheckoutData(SecureRemoteCommerceCheckoutData secureRemoteCommerceCheckoutData)`	secureRemoteCommerceCheckoutData
`void`	`setSessionValidity(String sessionValidity)`	The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
`void`	`setShopperEmail(String shopperEmail)`	The shopper's email address.
`void`	`setShopperInteraction(PaymentSetupRequest.ShopperInteractionEnum shopperInteraction)`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`void`	`setShopperIP(String shopperIP)`	The shopper's IP address.
`void`	`setShopperLocale(String shopperLocale)`	The combination of a language code and a country code to specify the language to be used in the payment.
`void`	`setShopperName(Name shopperName)`	shopperName
`void`	`setShopperReference(String shopperReference)`	Required for recurring payments.
`void`	`setShopperStatement(String shopperStatement)`	The text to be shown on the shopper's bank statement.
`void`	`setSocialSecurityNumber(String socialSecurityNumber)`	The shopper's social security number.
`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).
`void`	`setStore(String store)`	Required for Adyen for Platforms integrations if you are a platform model.
`void`	`setStorePaymentMethod(Boolean storePaymentMethod)`	When true and `shopperReference` is provided, the payment details will be stored.
`void`	`setTelephoneNumber(String telephoneNumber)`	The shopper's telephone number.
`void`	`setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`	Deprecated. since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
`void`	`setToken(String token)`	The token obtained when initializing the SDK.
`void`	`setTrustedShopper(Boolean trustedShopper)`	Set to true if the payment should be routed to a trusted MID.
`PaymentSetupRequest`	`shopperEmail(String shopperEmail)`	The shopper's email address.
`PaymentSetupRequest`	`shopperInteraction(PaymentSetupRequest.ShopperInteractionEnum shopperInteraction)`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`PaymentSetupRequest`	`shopperIP(String shopperIP)`	The shopper's IP address.
`PaymentSetupRequest`	`shopperLocale(String shopperLocale)`	The combination of a language code and a country code to specify the language to be used in the payment.
`PaymentSetupRequest`	`shopperName(Name shopperName)`	shopperName
`PaymentSetupRequest`	`shopperReference(String shopperReference)`	Required for recurring payments.
`PaymentSetupRequest`	`shopperStatement(String shopperStatement)`	The text to be shown on the shopper's bank statement.
`PaymentSetupRequest`	`socialSecurityNumber(String socialSecurityNumber)`	The shopper's social security number.
`PaymentSetupRequest`	`splits(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).
`PaymentSetupRequest`	`store(String store)`	Required for Adyen for Platforms integrations if you are a platform model.
`PaymentSetupRequest`	`storePaymentMethod(Boolean storePaymentMethod)`	When true and `shopperReference` is provided, the payment details will be stored.
`PaymentSetupRequest`	`telephoneNumber(String telephoneNumber)`	The shopper's telephone number.
`PaymentSetupRequest`	`threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`	Deprecated. since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
`String`	`toJson()`	Convert an instance of PaymentSetupRequest to an JSON string
`PaymentSetupRequest`	`token(String token)`	The token obtained when initializing the SDK.
`String`	`toString()`
`PaymentSetupRequest`	`trustedShopper(Boolean trustedShopper)`	Set to true if the payment should be routed to a trusted MID.

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

- Field Detail
  - 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_ALLOWED_PAYMENT_METHODS
```
public static final String JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
```
    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_BLOCKED_PAYMENT_METHODS
```
public static final String JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
```
    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_CHANNEL
```
public static final String JSON_PROPERTY_CHANNEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
```
public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COMPANY
```
public static final String JSON_PROPERTY_COMPANY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CONFIGURATION
```
public static final String JSON_PROPERTY_CONFIGURATION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CONVERSION_ID
```
public static final String JSON_PROPERTY_CONVERSION_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_COUNTRY_CODE
```
public static final String JSON_PROPERTY_COUNTRY_CODE
```
    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_ENABLE_ONE_CLICK
```
public static final String JSON_PROPERTY_ENABLE_ONE_CLICK
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ENABLE_PAY_OUT
```
public static final String JSON_PROPERTY_ENABLE_PAY_OUT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ENABLE_RECURRING
```
public static final String JSON_PROPERTY_ENABLE_RECURRING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ENTITY_TYPE
```
public static final String JSON_PROPERTY_ENTITY_TYPE
```
    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_LINE_ITEMS
```
public static final String JSON_PROPERTY_LINE_ITEMS
```
    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_MANDATE
```
public static final String JSON_PROPERTY_MANDATE
```
    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_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_ORIGIN
```
public static final String JSON_PROPERTY_ORIGIN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
```
public static final String JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RECURRING_EXPIRY
```
public static final String JSON_PROPERTY_RECURRING_EXPIRY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RECURRING_FREQUENCY
```
public static final String JSON_PROPERTY_RECURRING_FREQUENCY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RETURN_URL
```
public static final String JSON_PROPERTY_RETURN_URL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RISK_DATA
```
public static final String JSON_PROPERTY_RISK_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SDK_VERSION
```
public static final String JSON_PROPERTY_SDK_VERSION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SECURE_REMOTE_COMMERCE_CHECKOUT_DATA
```
public static final String JSON_PROPERTY_SECURE_REMOTE_COMMERCE_CHECKOUT_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SESSION_VALIDITY
```
public static final String JSON_PROPERTY_SESSION_VALIDITY
```
    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_STORE_PAYMENT_METHOD
```
public static final String JSON_PROPERTY_STORE_PAYMENT_METHOD
```
    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_S_AUTHENTICATION_ONLY
```
public static final String JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TOKEN
```
public static final String JSON_PROPERTY_TOKEN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRUSTED_SHOPPER
```
public static final String JSON_PROPERTY_TRUSTED_SHOPPER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentSetupRequest
```
public PaymentSetupRequest()
```
- Method Detail
  - additionalAmount
```
public PaymentSetupRequest additionalAmount(Amount additionalAmount)
```
    additionalAmount
    
    Parameters:
    
    additionalAmount -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getAdditionalAmount
```
public Amount getAdditionalAmount()
```
    additionalAmount
    
    Returns:
    
    additionalAmount
  - setAdditionalAmount
```
public void setAdditionalAmount(Amount additionalAmount)
```
    additionalAmount
    
    Parameters:
    
    additionalAmount -
  - additionalData
```
public PaymentSetupRequest additionalData(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - putAdditionalDataItem
```
public PaymentSetupRequest 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 -
  - allowedPaymentMethods
```
public PaymentSetupRequest allowedPaymentMethods(List<String> allowedPaymentMethods)
```
    List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    allowedPaymentMethods -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - addAllowedPaymentMethodsItem
```
public PaymentSetupRequest addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)
```
  - getAllowedPaymentMethods
```
public List<String> getAllowedPaymentMethods()
```
    List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    allowedPaymentMethods
  - setAllowedPaymentMethods
```
public void setAllowedPaymentMethods(List<String> allowedPaymentMethods)
```
    List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    allowedPaymentMethods -
  - amount
```
public PaymentSetupRequest amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - applicationInfo
```
public PaymentSetupRequest applicationInfo(ApplicationInfo applicationInfo)
```
    applicationInfo
    
    Parameters:
    
    applicationInfo -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
    applicationInfo
    
    Parameters:
    
    applicationInfo -
  - billingAddress
```
public PaymentSetupRequest billingAddress(Address billingAddress)
```
    billingAddress
    
    Parameters:
    
    billingAddress -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getBillingAddress
```
public Address getBillingAddress()
```
    billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
    billingAddress
    
    Parameters:
    
    billingAddress -
  - blockedPaymentMethods
```
public PaymentSetupRequest blockedPaymentMethods(List<String> blockedPaymentMethods)
```
    List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    blockedPaymentMethods -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - addBlockedPaymentMethodsItem
```
public PaymentSetupRequest addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)
```
  - getBlockedPaymentMethods
```
public List<String> getBlockedPaymentMethods()
```
    List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Returns:
    
    blockedPaymentMethods
  - setBlockedPaymentMethods
```
public void setBlockedPaymentMethods(List<String> blockedPaymentMethods)
```
    List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`
    
    Parameters:
    
    blockedPaymentMethods -
  - captureDelayHours
```
public PaymentSetupRequest captureDelayHours(Integer captureDelayHours)
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Parameters:
    
    captureDelayHours -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 -
  - channel
```
public PaymentSetupRequest channel(PaymentSetupRequest.ChannelEnum channel)
```
    The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web
    
    Parameters:
    
    channel -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getChannel
```
public PaymentSetupRequest.ChannelEnum getChannel()
```
    The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web
    
    Returns:
    
    channel
  - setChannel
```
public void setChannel(PaymentSetupRequest.ChannelEnum channel)
```
    The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web
    
    Parameters:
    
    channel -
  - checkoutAttemptId
```
public PaymentSetupRequest checkoutAttemptId(String checkoutAttemptId)
```
    Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
    
    Parameters:
    
    checkoutAttemptId -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getCheckoutAttemptId
```
public String getCheckoutAttemptId()
```
    Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
    
    Returns:
    
    checkoutAttemptId
  - setCheckoutAttemptId
```
public void setCheckoutAttemptId(String checkoutAttemptId)
```
    Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
    
    Parameters:
    
    checkoutAttemptId -
  - company
```
public PaymentSetupRequest company(Company company)
```
    company
    
    Parameters:
    
    company -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getCompany
```
public Company getCompany()
```
    company
    
    Returns:
    
    company
  - setCompany
```
public void setCompany(Company company)
```
    company
    
    Parameters:
    
    company -
  - configuration
```
public PaymentSetupRequest configuration(ModelConfiguration configuration)
```
    configuration
    
    Parameters:
    
    configuration -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getConfiguration
```
public ModelConfiguration getConfiguration()
```
    configuration
    
    Returns:
    
    configuration
  - setConfiguration
```
public void setConfiguration(ModelConfiguration configuration)
```
    configuration
    
    Parameters:
    
    configuration -
  - conversionId
```
@Deprecated
public PaymentSetupRequest conversionId(String conversionId)
```
    Deprecated.
    since Adyen Checkout API v68 Use `checkoutAttemptId` instead
    
    Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
    
    Parameters:
    
    conversionId -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getConversionId
```
@Deprecated
public String getConversionId()
```
    Deprecated.
    since Adyen Checkout API v68 Use `checkoutAttemptId` instead
    
    Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
    
    Returns:
    
    conversionId
  - setConversionId
```
@Deprecated
public void setConversionId(String conversionId)
```
    Deprecated.
    since Adyen Checkout API v68 Use `checkoutAttemptId` instead
    
    Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
    
    Parameters:
    
    conversionId -
  - countryCode
```
public PaymentSetupRequest countryCode(String countryCode)
```
    The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
    
    Parameters:
    
    countryCode -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getCountryCode
```
public String getCountryCode()
```
    The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
    
    Returns:
    
    countryCode
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
    The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE
    
    Parameters:
    
    countryCode -
  - dateOfBirth
```
public PaymentSetupRequest dateOfBirth(LocalDate dateOfBirth)
```
    The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
    
    Parameters:
    
    dateOfBirth -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest dccQuote(ForexQuote dccQuote)
```
    dccQuote
    
    Parameters:
    
    dccQuote -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getDccQuote
```
public ForexQuote getDccQuote()
```
    dccQuote
    
    Returns:
    
    dccQuote
  - setDccQuote
```
public void setDccQuote(ForexQuote dccQuote)
```
    dccQuote
    
    Parameters:
    
    dccQuote -
  - deliveryAddress
```
public PaymentSetupRequest deliveryAddress(Address deliveryAddress)
```
    deliveryAddress
    
    Parameters:
    
    deliveryAddress -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getDeliveryAddress
```
public Address getDeliveryAddress()
```
    deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(Address deliveryAddress)
```
    deliveryAddress
    
    Parameters:
    
    deliveryAddress -
  - deliveryDate
```
public PaymentSetupRequest deliveryDate(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 -
  - enableOneClick
```
public PaymentSetupRequest enableOneClick(Boolean enableOneClick)
```
    When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
    
    Parameters:
    
    enableOneClick -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getEnableOneClick
```
public Boolean getEnableOneClick()
```
    When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
    
    Returns:
    
    enableOneClick
  - setEnableOneClick
```
public void setEnableOneClick(Boolean enableOneClick)
```
    When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
    
    Parameters:
    
    enableOneClick -
  - enablePayOut
```
public PaymentSetupRequest enablePayOut(Boolean enablePayOut)
```
    When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
    
    Parameters:
    
    enablePayOut -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getEnablePayOut
```
public Boolean getEnablePayOut()
```
    When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
    
    Returns:
    
    enablePayOut
  - setEnablePayOut
```
public void setEnablePayOut(Boolean enablePayOut)
```
    When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
    
    Parameters:
    
    enablePayOut -
  - enableRecurring
```
public PaymentSetupRequest enableRecurring(Boolean enableRecurring)
```
    When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
    
    Parameters:
    
    enableRecurring -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getEnableRecurring
```
public Boolean getEnableRecurring()
```
    When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
    
    Returns:
    
    enableRecurring
  - setEnableRecurring
```
public void setEnableRecurring(Boolean enableRecurring)
```
    When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
    
    Parameters:
    
    enableRecurring -
  - entityType
```
public PaymentSetupRequest entityType(PaymentSetupRequest.EntityTypeEnum entityType)
```
    The type of the entity the payment is processed for.
    
    Parameters:
    
    entityType -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getEntityType
```
public PaymentSetupRequest.EntityTypeEnum getEntityType()
```
    The type of the entity the payment is processed for.
    
    Returns:
    
    entityType
  - setEntityType
```
public void setEntityType(PaymentSetupRequest.EntityTypeEnum entityType)
```
    The type of the entity the payment is processed for.
    
    Parameters:
    
    entityType -
  - fraudOffset
```
public PaymentSetupRequest fraudOffset(Integer fraudOffset)
```
    An integer value that is added to the normal fraud score. The value can be either positive or negative.
    
    Parameters:
    
    fraudOffset -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest installments(Installments installments)
```
    installments
    
    Parameters:
    
    installments -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getInstallments
```
public Installments getInstallments()
```
    installments
    
    Returns:
    
    installments
  - setInstallments
```
public void setInstallments(Installments installments)
```
    installments
    
    Parameters:
    
    installments -
  - lineItems
```
public PaymentSetupRequest lineItems(List<LineItem> lineItems)
```
    Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.
    
    Parameters:
    
    lineItems -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - addLineItemsItem
```
public PaymentSetupRequest addLineItemsItem(LineItem lineItemsItem)
```
  - getLineItems
```
public List<LineItem> getLineItems()
```
    Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
    Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.
    
    Parameters:
    
    lineItems -
  - localizedShopperStatement
```
public PaymentSetupRequest localizedShopperStatement(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - putLocalizedShopperStatementItem
```
public PaymentSetupRequest 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 -
  - mandate
```
public PaymentSetupRequest mandate(Mandate mandate)
```
    mandate
    
    Parameters:
    
    mandate -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getMandate
```
public Mandate getMandate()
```
    mandate
    
    Returns:
    
    mandate
  - setMandate
```
public void setMandate(Mandate mandate)
```
    mandate
    
    Parameters:
    
    mandate -
  - mcc
```
public PaymentSetupRequest mcc(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest merchantAccount(String merchantAccount)
```
    The merchant account identifier, with which you want to process the transaction.
    
    Parameters:
    
    merchantAccount -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest merchantOrderReference(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 -
  - metadata
```
public PaymentSetupRequest metadata(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - putMetadataItem
```
public PaymentSetupRequest 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 PaymentSetupRequest orderReference(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 -
  - origin
```
public PaymentSetupRequest origin(String origin)
```
    Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from.
    
    Parameters:
    
    origin -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getOrigin
```
public String getOrigin()
```
    Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from.
    
    Returns:
    
    origin
  - setOrigin
```
public void setOrigin(String origin)
```
    Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from.
    
    Parameters:
    
    origin -
  - platformChargebackLogic
```
public PaymentSetupRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getPlatformChargebackLogic
```
public PlatformChargebackLogic getPlatformChargebackLogic()
```
    platformChargebackLogic
    
    Returns:
    
    platformChargebackLogic
  - setPlatformChargebackLogic
```
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
  - recurringExpiry
```
public PaymentSetupRequest recurringExpiry(String recurringExpiry)
```
    Date after which no further authorisations shall be performed. Only for 3D Secure 2.
    
    Parameters:
    
    recurringExpiry -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getRecurringExpiry
```
public String getRecurringExpiry()
```
    Date after which no further authorisations shall be performed. Only for 3D Secure 2.
    
    Returns:
    
    recurringExpiry
  - setRecurringExpiry
```
public void setRecurringExpiry(String recurringExpiry)
```
    Date after which no further authorisations shall be performed. Only for 3D Secure 2.
    
    Parameters:
    
    recurringExpiry -
  - recurringFrequency
```
public PaymentSetupRequest recurringFrequency(String recurringFrequency)
```
    Minimum number of days between authorisations. Only for 3D Secure 2.
    
    Parameters:
    
    recurringFrequency -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getRecurringFrequency
```
public String getRecurringFrequency()
```
    Minimum number of days between authorisations. Only for 3D Secure 2.
    
    Returns:
    
    recurringFrequency
  - setRecurringFrequency
```
public void setRecurringFrequency(String recurringFrequency)
```
    Minimum number of days between authorisations. Only for 3D Secure 2.
    
    Parameters:
    
    recurringFrequency -
  - reference
```
public PaymentSetupRequest reference(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 -
  - returnUrl
```
public PaymentSetupRequest returnUrl(String returnUrl)
```
    The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.
    
    Parameters:
    
    returnUrl -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getReturnUrl
```
public String getReturnUrl()
```
    The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.
    
    Returns:
    
    returnUrl
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
    The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. > The URL must not include personally identifiable information (PII), for example name or email address.
    
    Parameters:
    
    returnUrl -
  - riskData
```
public PaymentSetupRequest riskData(RiskData riskData)
```
    riskData
    
    Parameters:
    
    riskData -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getRiskData
```
public RiskData getRiskData()
```
    riskData
    
    Returns:
    
    riskData
  - setRiskData
```
public void setRiskData(RiskData riskData)
```
    riskData
    
    Parameters:
    
    riskData -
  - sdkVersion
```
public PaymentSetupRequest sdkVersion(String sdkVersion)
```
    The version of the SDK you are using (for Web SDK integrations only).
    
    Parameters:
    
    sdkVersion -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getSdkVersion
```
public String getSdkVersion()
```
    The version of the SDK you are using (for Web SDK integrations only).
    
    Returns:
    
    sdkVersion
  - setSdkVersion
```
public void setSdkVersion(String sdkVersion)
```
    The version of the SDK you are using (for Web SDK integrations only).
    
    Parameters:
    
    sdkVersion -
  - secureRemoteCommerceCheckoutData
```
public PaymentSetupRequest secureRemoteCommerceCheckoutData(SecureRemoteCommerceCheckoutData secureRemoteCommerceCheckoutData)
```
    secureRemoteCommerceCheckoutData
    
    Parameters:
    
    secureRemoteCommerceCheckoutData -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getSecureRemoteCommerceCheckoutData
```
public SecureRemoteCommerceCheckoutData getSecureRemoteCommerceCheckoutData()
```
    secureRemoteCommerceCheckoutData
    
    Returns:
    
    secureRemoteCommerceCheckoutData
  - setSecureRemoteCommerceCheckoutData
```
public void setSecureRemoteCommerceCheckoutData(SecureRemoteCommerceCheckoutData secureRemoteCommerceCheckoutData)
```
    secureRemoteCommerceCheckoutData
    
    Parameters:
    
    secureRemoteCommerceCheckoutData -
  - sessionValidity
```
public PaymentSetupRequest sessionValidity(String sessionValidity)
```
    The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00
    
    Parameters:
    
    sessionValidity -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getSessionValidity
```
public String getSessionValidity()
```
    The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00
    
    Returns:
    
    sessionValidity
  - setSessionValidity
```
public void setSessionValidity(String sessionValidity)
```
    The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00
    
    Parameters:
    
    sessionValidity -
  - shopperEmail
```
public PaymentSetupRequest shopperEmail(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest shopperIP(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest shopperInteraction(PaymentSetupRequest.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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getShopperInteraction
```
public PaymentSetupRequest.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(PaymentSetupRequest.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 PaymentSetupRequest shopperLocale(String shopperLocale)
```
    The combination of a language code and a country code to specify the language to be used in the payment.
    
    Parameters:
    
    shopperLocale -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest shopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getShopperName
```
public Name getShopperName()
```
    shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
  - shopperReference
```
public PaymentSetupRequest shopperReference(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest shopperStatement(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest socialSecurityNumber(String socialSecurityNumber)
```
    The shopper's social security number.
    
    Parameters:
    
    socialSecurityNumber -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest splits(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - addSplitsItem
```
public PaymentSetupRequest 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 PaymentSetupRequest store(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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 -
  - storePaymentMethod
```
public PaymentSetupRequest storePaymentMethod(Boolean storePaymentMethod)
```
    When true and `shopperReference` is provided, the payment details will be stored.
    
    Parameters:
    
    storePaymentMethod -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getStorePaymentMethod
```
public Boolean getStorePaymentMethod()
```
    When true and `shopperReference` is provided, the payment details will be stored.
    
    Returns:
    
    storePaymentMethod
  - setStorePaymentMethod
```
public void setStorePaymentMethod(Boolean storePaymentMethod)
```
    When true and `shopperReference` is provided, the payment details will be stored.
    
    Parameters:
    
    storePaymentMethod -
  - telephoneNumber
```
public PaymentSetupRequest telephoneNumber(String telephoneNumber)
```
    The shopper's telephone number.
    
    Parameters:
    
    telephoneNumber -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getTelephoneNumber
```
public String getTelephoneNumber()
```
    The shopper's telephone number.
    
    Returns:
    
    telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(String telephoneNumber)
```
    The shopper's telephone number.
    
    Parameters:
    
    telephoneNumber -
  - threeDSAuthenticationOnly
```
@Deprecated
public PaymentSetupRequest threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
```
    Deprecated.
    since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
    
    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 -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getThreeDSAuthenticationOnly
```
@Deprecated
public Boolean getThreeDSAuthenticationOnly()
```
    Deprecated.
    since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
    
    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
```
@Deprecated
public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
```
    Deprecated.
    since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
    
    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 -
  - token
```
public PaymentSetupRequest token(String token)
```
    The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web.
    
    Parameters:
    
    token -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - getToken
```
public String getToken()
```
    The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web.
    
    Returns:
    
    token
  - setToken
```
public void setToken(String token)
```
    The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web.
    
    Parameters:
    
    token -
  - trustedShopper
```
public PaymentSetupRequest trustedShopper(Boolean trustedShopper)
```
    Set to true if the payment should be routed to a trusted MID.
    
    Parameters:
    
    trustedShopper -
    
    Returns:
    
    the current PaymentSetupRequest instance, allowing for method chaining
  - 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 PaymentSetupRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static PaymentSetupRequest fromJson(String jsonString)
                                    throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentSetupRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentSetupRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentSetupRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentSetupRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PaymentSetupRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ADDITIONAL_AMOUNT

JSON_PROPERTY_ADDITIONAL_DATA

JSON_PROPERTY_ALLOWED_PAYMENT_METHODS

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_APPLICATION_INFO

JSON_PROPERTY_BILLING_ADDRESS

JSON_PROPERTY_BLOCKED_PAYMENT_METHODS

JSON_PROPERTY_CAPTURE_DELAY_HOURS

JSON_PROPERTY_CHANNEL

JSON_PROPERTY_CHECKOUT_ATTEMPT_ID

JSON_PROPERTY_COMPANY

JSON_PROPERTY_CONFIGURATION

JSON_PROPERTY_CONVERSION_ID

JSON_PROPERTY_COUNTRY_CODE

JSON_PROPERTY_DATE_OF_BIRTH

JSON_PROPERTY_DCC_QUOTE

JSON_PROPERTY_DELIVERY_ADDRESS

JSON_PROPERTY_DELIVERY_DATE

JSON_PROPERTY_ENABLE_ONE_CLICK

JSON_PROPERTY_ENABLE_PAY_OUT

JSON_PROPERTY_ENABLE_RECURRING

JSON_PROPERTY_ENTITY_TYPE

JSON_PROPERTY_FRAUD_OFFSET

JSON_PROPERTY_INSTALLMENTS

JSON_PROPERTY_LINE_ITEMS

JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT

JSON_PROPERTY_MANDATE

JSON_PROPERTY_MCC

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_MERCHANT_ORDER_REFERENCE

JSON_PROPERTY_METADATA

JSON_PROPERTY_ORDER_REFERENCE

JSON_PROPERTY_ORIGIN

JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC

JSON_PROPERTY_RECURRING_EXPIRY

JSON_PROPERTY_RECURRING_FREQUENCY

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_RETURN_URL

JSON_PROPERTY_RISK_DATA

JSON_PROPERTY_SDK_VERSION

JSON_PROPERTY_SECURE_REMOTE_COMMERCE_CHECKOUT_DATA

JSON_PROPERTY_SESSION_VALIDITY

JSON_PROPERTY_SHOPPER_EMAIL

JSON_PROPERTY_SHOPPER_I_P

JSON_PROPERTY_SHOPPER_INTERACTION

JSON_PROPERTY_SHOPPER_LOCALE

JSON_PROPERTY_SHOPPER_NAME

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_SHOPPER_STATEMENT

JSON_PROPERTY_SOCIAL_SECURITY_NUMBER

JSON_PROPERTY_SPLITS

JSON_PROPERTY_STORE

JSON_PROPERTY_STORE_PAYMENT_METHOD

JSON_PROPERTY_TELEPHONE_NUMBER

JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY

JSON_PROPERTY_TOKEN

JSON_PROPERTY_TRUSTED_SHOPPER

Constructor Detail

PaymentSetupRequest

Method Detail

additionalAmount

getAdditionalAmount

setAdditionalAmount

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

allowedPaymentMethods

addAllowedPaymentMethodsItem

getAllowedPaymentMethods

setAllowedPaymentMethods

amount

getAmount