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

public class PaymentRequest
extends Object

PaymentRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PaymentRequest.ChannelEnum`	The platform where a payment transaction takes place.
`static class`	`PaymentRequest.EntityTypeEnum`	The type of the entity the payment is processed for.
`static class`	`PaymentRequest.IndustryUsageEnum`	The reason for the amount update.
`static class`	`PaymentRequest.RecurringProcessingModelEnum`	Defines a recurring payment type.
`static class`	`PaymentRequest.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_ACCOUNT_INFO`
`static String`	`JSON_PROPERTY_ADDITIONAL_AMOUNT`
`static String`	`JSON_PROPERTY_ADDITIONAL_DATA`
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_APPLICATION_INFO`
`static String`	`JSON_PROPERTY_AUTHENTICATION_DATA`
`static String`	`JSON_PROPERTY_BANK_ACCOUNT`
`static String`	`JSON_PROPERTY_BILLING_ADDRESS`
`static String`	`JSON_PROPERTY_BROWSER_INFO`
`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_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_DELIVER_AT`
`static String`	`JSON_PROPERTY_DELIVERY_ADDRESS`
`static String`	`JSON_PROPERTY_DELIVERY_DATE`
`static String`	`JSON_PROPERTY_DEVICE_FINGERPRINT`
`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_FUND_ORIGIN`
`static String`	`JSON_PROPERTY_FUND_RECIPIENT`
`static String`	`JSON_PROPERTY_INDUSTRY_USAGE`
`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_MERCHANT_RISK_INDICATOR`
`static String`	`JSON_PROPERTY_METADATA`
`static String`	`JSON_PROPERTY_MPI_DATA`
`static String`	`JSON_PROPERTY_ORDER`
`static String`	`JSON_PROPERTY_ORDER_REFERENCE`
`static String`	`JSON_PROPERTY_ORIGIN`
`static String`	`JSON_PROPERTY_PAYMENT_METHOD`
`static String`	`JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC`
`static String`	`JSON_PROPERTY_RECURRING_EXPIRY`
`static String`	`JSON_PROPERTY_RECURRING_FREQUENCY`
`static String`	`JSON_PROPERTY_RECURRING_PROCESSING_MODEL`
`static String`	`JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD`
`static String`	`JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_RETURN_URL`
`static String`	`JSON_PROPERTY_RISK_DATA`
`static String`	`JSON_PROPERTY_SESSION_VALIDITY`
`static String`	`JSON_PROPERTY_SHOPPER_CONVERSION_ID`
`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_SUB_MERCHANTS`
`static String`	`JSON_PROPERTY_TELEPHONE_NUMBER`
`static String`	`JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY`
`static String`	`JSON_PROPERTY_THREE_D_S2_REQUEST_DATA`
`static String`	`JSON_PROPERTY_TRUSTED_SHOPPER`

Constructor Summary

Constructors
Constructor Description

PaymentRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`PaymentRequest`	`accountInfo(AccountInfo accountInfo)`	accountInfo
`PaymentRequest`	`additionalAmount(Amount additionalAmount)`	additionalAmount
`PaymentRequest`	`additionalData(Map<String,String> additionalData)`	This field contains additional data, which may be required for a particular payment request.
`PaymentRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentRequest`	`addSplitsItem(Split splitsItem)`
`PaymentRequest`	`addSubMerchantsItem(SubMerchantInfo subMerchantsItem)`
`PaymentRequest`	`amount(Amount amount)`	amount
`PaymentRequest`	`applicationInfo(ApplicationInfo applicationInfo)`	applicationInfo
`PaymentRequest`	`authenticationData(AuthenticationData authenticationData)`	authenticationData
`PaymentRequest`	`bankAccount(CheckoutBankAccount bankAccount)`	bankAccount
`PaymentRequest`	`billingAddress(BillingAddress billingAddress)`	billingAddress
`PaymentRequest`	`browserInfo(BrowserInfo browserInfo)`	browserInfo
`PaymentRequest`	`captureDelayHours(Integer captureDelayHours)`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`PaymentRequest`	`channel(PaymentRequest.ChannelEnum channel)`	The platform where a payment transaction takes place.
`PaymentRequest`	`checkoutAttemptId(String checkoutAttemptId)`	Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
`PaymentRequest`	`company(Company company)`	company
`PaymentRequest`	`conversionId(String conversionId)`	Deprecated. since Adyen Checkout API v68 Use `checkoutAttemptId` instead
`PaymentRequest`	`countryCode(String countryCode)`	The shopper country.
`PaymentRequest`	`dateOfBirth(OffsetDateTime dateOfBirth)`	The shopper's date of birth.
`PaymentRequest`	`dccQuote(ForexQuote dccQuote)`	dccQuote
`PaymentRequest`	`deliverAt(OffsetDateTime deliverAt)`	The date and time the purchased goods should be delivered.
`PaymentRequest`	`deliveryAddress(DeliveryAddress deliveryAddress)`	deliveryAddress
`PaymentRequest`	`deliveryDate(OffsetDateTime deliveryDate)`	Deprecated. since Adyen Checkout API v70 Use `deliverAt` instead.
`PaymentRequest`	`deviceFingerprint(String deviceFingerprint)`	A string containing the shopper's device fingerprint.
`PaymentRequest`	`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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
`PaymentRequest`	`enablePayOut(Boolean enablePayOut)`	When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
`PaymentRequest`	`enableRecurring(Boolean enableRecurring)`	When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
`PaymentRequest`	`entityType(PaymentRequest.EntityTypeEnum entityType)`	The type of the entity the payment is processed for.
`boolean`	`equals(Object o)`	Return true if this PaymentRequest object is equal to o.
`PaymentRequest`	`fraudOffset(Integer fraudOffset)`	An integer value that is added to the normal fraud score.
`static PaymentRequest`	`fromJson(String jsonString)`	Create an instance of PaymentRequest given an JSON string
`PaymentRequest`	`fundOrigin(FundOrigin fundOrigin)`	fundOrigin
`PaymentRequest`	`fundRecipient(FundRecipient fundRecipient)`	fundRecipient
`AccountInfo`	`getAccountInfo()`	accountInfo
`Amount`	`getAdditionalAmount()`	additionalAmount
`Map<String,String>`	`getAdditionalData()`	This field contains additional data, which may be required for a particular payment request.
`Amount`	`getAmount()`	amount
`ApplicationInfo`	`getApplicationInfo()`	applicationInfo
`AuthenticationData`	`getAuthenticationData()`	authenticationData
`CheckoutBankAccount`	`getBankAccount()`	bankAccount
`BillingAddress`	`getBillingAddress()`	billingAddress
`BrowserInfo`	`getBrowserInfo()`	browserInfo
`Integer`	`getCaptureDelayHours()`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`PaymentRequest.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
`String`	`getConversionId()`	Deprecated. since Adyen Checkout API v68 Use `checkoutAttemptId` instead
`String`	`getCountryCode()`	The shopper country.
`OffsetDateTime`	`getDateOfBirth()`	The shopper's date of birth.
`ForexQuote`	`getDccQuote()`	dccQuote
`OffsetDateTime`	`getDeliverAt()`	The date and time the purchased goods should be delivered.
`DeliveryAddress`	`getDeliveryAddress()`	deliveryAddress
`OffsetDateTime`	`getDeliveryDate()`	Deprecated. since Adyen Checkout API v70 Use `deliverAt` instead.
`String`	`getDeviceFingerprint()`	A string containing the shopper's device fingerprint.
`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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
`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 stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
`PaymentRequest.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.
`FundOrigin`	`getFundOrigin()`	fundOrigin
`FundRecipient`	`getFundRecipient()`	fundRecipient
`PaymentRequest.IndustryUsageEnum`	`getIndustryUsage()`	The reason for the amount update.
`Installments`	`getInstallments()`	installments
`List<LineItem>`	`getLineItems()`	Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`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).
`MerchantRiskIndicator`	`getMerchantRiskIndicator()`	merchantRiskIndicator
`Map<String,String>`	`getMetadata()`	Metadata consists of entries, each of which includes a key and a value.
`ThreeDSecureData`	`getMpiData()`	mpiData
`EncryptedOrderData`	`getOrder()`	order
`String`	`getOrderReference()`	When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
`String`	`getOrigin()`	Required for the 3D Secure 2 `channel` Web integration.
`CheckoutPaymentMethod`	`getPaymentMethod()`	paymentMethod
`PlatformChargebackLogic`	`getPlatformChargebackLogic()`	platformChargebackLogic
`String`	`getRecurringExpiry()`	Date after which no further authorisations shall be performed.
`String`	`getRecurringFrequency()`	Minimum number of days between authorisations.
`PaymentRequest.RecurringProcessingModelEnum`	`getRecurringProcessingModel()`	Defines a recurring payment type.
`String`	`getRedirectFromIssuerMethod()`	Specifies the redirect method (GET or POST) when redirecting back from the issuer.
`String`	`getRedirectToIssuerMethod()`	Specifies the redirect method (GET or POST) when redirecting to the issuer.
`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`	`getSessionValidity()`	The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
`String`	`getShopperConversionId()`	A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
`String`	`getShopperEmail()`	The shopper's email address.
`PaymentRequest.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 to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/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 for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
`List<SubMerchantInfo>`	`getSubMerchants()`	This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
`String`	`getTelephoneNumber()`	The shopper's telephone number.
`ThreeDS2RequestFields`	`getThreeDS2RequestData()`	threeDS2RequestData
`Boolean`	`getThreeDSAuthenticationOnly()`	Deprecated. since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
`Boolean`	`getTrustedShopper()`	Set to true if the payment should be routed to a trusted MID.
`int`	`hashCode()`
`PaymentRequest`	`industryUsage(PaymentRequest.IndustryUsageEnum industryUsage)`	The reason for the amount update.
`PaymentRequest`	`installments(Installments installments)`	installments
`PaymentRequest`	`lineItems(List<LineItem> lineItems)`	Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`PaymentRequest`	`localizedShopperStatement(Map<String,String> localizedShopperStatement)`	The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.
`PaymentRequest`	`mandate(Mandate mandate)`	mandate
`PaymentRequest`	`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.
`PaymentRequest`	`merchantAccount(String merchantAccount)`	The merchant account identifier, with which you want to process the transaction.
`PaymentRequest`	`merchantOrderReference(String merchantOrderReference)`	This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).
`PaymentRequest`	`merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)`	merchantRiskIndicator
`PaymentRequest`	`metadata(Map<String,String> metadata)`	Metadata consists of entries, each of which includes a key and a value.
`PaymentRequest`	`mpiData(ThreeDSecureData mpiData)`	mpiData
`PaymentRequest`	`order(EncryptedOrderData order)`	order
`PaymentRequest`	`orderReference(String orderReference)`	When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
`PaymentRequest`	`origin(String origin)`	Required for the 3D Secure 2 `channel` Web integration.
`PaymentRequest`	`paymentMethod(CheckoutPaymentMethod paymentMethod)`	paymentMethod
`PaymentRequest`	`platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)`	platformChargebackLogic
`PaymentRequest`	`putAdditionalDataItem(String key, String additionalDataItem)`
`PaymentRequest`	`putLocalizedShopperStatementItem(String key, String localizedShopperStatementItem)`
`PaymentRequest`	`putMetadataItem(String key, String metadataItem)`
`PaymentRequest`	`recurringExpiry(String recurringExpiry)`	Date after which no further authorisations shall be performed.
`PaymentRequest`	`recurringFrequency(String recurringFrequency)`	Minimum number of days between authorisations.
`PaymentRequest`	`recurringProcessingModel(PaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)`	Defines a recurring payment type.
`PaymentRequest`	`redirectFromIssuerMethod(String redirectFromIssuerMethod)`	Specifies the redirect method (GET or POST) when redirecting back from the issuer.
`PaymentRequest`	`redirectToIssuerMethod(String redirectToIssuerMethod)`	Specifies the redirect method (GET or POST) when redirecting to the issuer.
`PaymentRequest`	`reference(String reference)`	The reference to uniquely identify a payment.
`PaymentRequest`	`returnUrl(String returnUrl)`	The URL to return to in case of a redirection.
`PaymentRequest`	`riskData(RiskData riskData)`	riskData
`PaymentRequest`	`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`	`setAccountInfo(AccountInfo accountInfo)`	accountInfo
`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`	`setAmount(Amount amount)`	amount
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`	applicationInfo
`void`	`setAuthenticationData(AuthenticationData authenticationData)`	authenticationData
`void`	`setBankAccount(CheckoutBankAccount bankAccount)`	bankAccount
`void`	`setBillingAddress(BillingAddress billingAddress)`	billingAddress
`void`	`setBrowserInfo(BrowserInfo browserInfo)`	browserInfo
`void`	`setCaptureDelayHours(Integer captureDelayHours)`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`void`	`setChannel(PaymentRequest.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`	`setConversionId(String conversionId)`	Deprecated. since Adyen Checkout API v68 Use `checkoutAttemptId` instead
`void`	`setCountryCode(String countryCode)`	The shopper country.
`void`	`setDateOfBirth(OffsetDateTime dateOfBirth)`	The shopper's date of birth.
`void`	`setDccQuote(ForexQuote dccQuote)`	dccQuote
`void`	`setDeliverAt(OffsetDateTime deliverAt)`	The date and time the purchased goods should be delivered.
`void`	`setDeliveryAddress(DeliveryAddress deliveryAddress)`	deliveryAddress
`void`	`setDeliveryDate(OffsetDateTime deliveryDate)`	Deprecated. since Adyen Checkout API v70 Use `deliverAt` instead.
`void`	`setDeviceFingerprint(String deviceFingerprint)`	A string containing the shopper's device fingerprint.
`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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
`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 stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
`void`	`setEntityType(PaymentRequest.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`	`setFundOrigin(FundOrigin fundOrigin)`	fundOrigin
`void`	`setFundRecipient(FundRecipient fundRecipient)`	fundRecipient
`void`	`setIndustryUsage(PaymentRequest.IndustryUsageEnum industryUsage)`	The reason for the amount update.
`void`	`setInstallments(Installments installments)`	installments
`void`	`setLineItems(List<LineItem> lineItems)`	Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`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`	`setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)`	merchantRiskIndicator
`void`	`setMetadata(Map<String,String> metadata)`	Metadata consists of entries, each of which includes a key and a value.
`void`	`setMpiData(ThreeDSecureData mpiData)`	mpiData
`void`	`setOrder(EncryptedOrderData order)`	order
`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 3D Secure 2 `channel` Web integration.
`void`	`setPaymentMethod(CheckoutPaymentMethod paymentMethod)`	paymentMethod
`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`	`setRecurringProcessingModel(PaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)`	Defines a recurring payment type.
`void`	`setRedirectFromIssuerMethod(String redirectFromIssuerMethod)`	Specifies the redirect method (GET or POST) when redirecting back from the issuer.
`void`	`setRedirectToIssuerMethod(String redirectToIssuerMethod)`	Specifies the redirect method (GET or POST) when redirecting to the issuer.
`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`	`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`	`setShopperConversionId(String shopperConversionId)`	A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
`void`	`setShopperEmail(String shopperEmail)`	The shopper's email address.
`void`	`setShopperInteraction(PaymentRequest.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 to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/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 for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
`void`	`setSubMerchants(List<SubMerchantInfo> subMerchants)`	This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
`void`	`setTelephoneNumber(String telephoneNumber)`	The shopper's telephone number.
`void`	`setThreeDS2RequestData(ThreeDS2RequestFields threeDS2RequestData)`	threeDS2RequestData
`void`	`setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`	Deprecated. since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
`void`	`setTrustedShopper(Boolean trustedShopper)`	Set to true if the payment should be routed to a trusted MID.
`PaymentRequest`	`shopperConversionId(String shopperConversionId)`	A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
`PaymentRequest`	`shopperEmail(String shopperEmail)`	The shopper's email address.
`PaymentRequest`	`shopperInteraction(PaymentRequest.ShopperInteractionEnum shopperInteraction)`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`PaymentRequest`	`shopperIP(String shopperIP)`	The shopper's IP address.
`PaymentRequest`	`shopperLocale(String shopperLocale)`	The combination of a language code and a country code to specify the language to be used in the payment.
`PaymentRequest`	`shopperName(Name shopperName)`	shopperName
`PaymentRequest`	`shopperReference(String shopperReference)`	Required for recurring payments.
`PaymentRequest`	`shopperStatement(String shopperStatement)`	The text to be shown on the shopper's bank statement.
`PaymentRequest`	`socialSecurityNumber(String socialSecurityNumber)`	The shopper's social security number.
`PaymentRequest`	`splits(List<Split> splits)`	An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
`PaymentRequest`	`store(String store)`	Required for Adyen for Platforms integrations if you are a platform model.
`PaymentRequest`	`storePaymentMethod(Boolean storePaymentMethod)`	When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
`PaymentRequest`	`subMerchants(List<SubMerchantInfo> subMerchants)`	This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
`PaymentRequest`	`telephoneNumber(String telephoneNumber)`	The shopper's telephone number.
`PaymentRequest`	`threeDS2RequestData(ThreeDS2RequestFields threeDS2RequestData)`	threeDS2RequestData
`PaymentRequest`	`threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`	Deprecated. since Adyen Checkout API v69 Use `authenticationData.authenticationOnly` instead.
`String`	`toJson()`	Convert an instance of PaymentRequest to an JSON string
`String`	`toString()`
`PaymentRequest`	`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_ACCOUNT_INFO
```
public static final String JSON_PROPERTY_ACCOUNT_INFO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ADDITIONAL_AMOUNT
```
public static final String JSON_PROPERTY_ADDITIONAL_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ADDITIONAL_DATA
```
public static final String JSON_PROPERTY_ADDITIONAL_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_APPLICATION_INFO
```
public static final String JSON_PROPERTY_APPLICATION_INFO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AUTHENTICATION_DATA
```
public static final String JSON_PROPERTY_AUTHENTICATION_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BANK_ACCOUNT
```
public static final String JSON_PROPERTY_BANK_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BILLING_ADDRESS
```
public static final String JSON_PROPERTY_BILLING_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BROWSER_INFO
```
public static final String JSON_PROPERTY_BROWSER_INFO
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CAPTURE_DELAY_HOURS
```
public static final String JSON_PROPERTY_CAPTURE_DELAY_HOURS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_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_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_DELIVER_AT
```
public static final String JSON_PROPERTY_DELIVER_AT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DELIVERY_ADDRESS
```
public static final String JSON_PROPERTY_DELIVERY_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DELIVERY_DATE
```
public static final String JSON_PROPERTY_DELIVERY_DATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DEVICE_FINGERPRINT
```
public static final String JSON_PROPERTY_DEVICE_FINGERPRINT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_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_FUND_ORIGIN
```
public static final String JSON_PROPERTY_FUND_ORIGIN
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FUND_RECIPIENT
```
public static final String JSON_PROPERTY_FUND_RECIPIENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_INDUSTRY_USAGE
```
public static final String JSON_PROPERTY_INDUSTRY_USAGE
```
    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_MERCHANT_RISK_INDICATOR
```
public static final String JSON_PROPERTY_MERCHANT_RISK_INDICATOR
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_METADATA
```
public static final String JSON_PROPERTY_METADATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MPI_DATA
```
public static final String JSON_PROPERTY_MPI_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ORDER
```
public static final String JSON_PROPERTY_ORDER
```
    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_PAYMENT_METHOD
```
public static final String JSON_PROPERTY_PAYMENT_METHOD
```
    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_RECURRING_PROCESSING_MODEL
```
public static final String JSON_PROPERTY_RECURRING_PROCESSING_MODEL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD
```
public static final String JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD
```
public static final String JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD
```
    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_SESSION_VALIDITY
```
public static final String JSON_PROPERTY_SESSION_VALIDITY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_CONVERSION_ID
```
public static final String JSON_PROPERTY_SHOPPER_CONVERSION_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_EMAIL
```
public static final String JSON_PROPERTY_SHOPPER_EMAIL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_I_P
```
public static final String JSON_PROPERTY_SHOPPER_I_P
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_INTERACTION
```
public static final String JSON_PROPERTY_SHOPPER_INTERACTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_LOCALE
```
public static final String JSON_PROPERTY_SHOPPER_LOCALE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_NAME
```
public static final String JSON_PROPERTY_SHOPPER_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_STATEMENT
```
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SPLITS
```
public static final String JSON_PROPERTY_SPLITS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORE
```
public static final String JSON_PROPERTY_STORE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_STORE_PAYMENT_METHOD
```
public static final String JSON_PROPERTY_STORE_PAYMENT_METHOD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SUB_MERCHANTS
```
public static final String JSON_PROPERTY_SUB_MERCHANTS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TELEPHONE_NUMBER
```
public static final String JSON_PROPERTY_TELEPHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
```
public static final String JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
```
public static final String JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TRUSTED_SHOPPER
```
public static final String JSON_PROPERTY_TRUSTED_SHOPPER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PaymentRequest
```
public PaymentRequest()
```
- Method Detail
  - accountInfo
```
public PaymentRequest accountInfo(AccountInfo accountInfo)
```
    accountInfo
    
    Parameters:
    
    accountInfo -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getAccountInfo
```
public AccountInfo getAccountInfo()
```
    accountInfo
    
    Returns:
    
    accountInfo
  - setAccountInfo
```
public void setAccountInfo(AccountInfo accountInfo)
```
    accountInfo
    
    Parameters:
    
    accountInfo -
  - additionalAmount
```
public PaymentRequest additionalAmount(Amount additionalAmount)
```
    additionalAmount
    
    Parameters:
    
    additionalAmount -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getAdditionalAmount
```
public Amount getAdditionalAmount()
```
    additionalAmount
    
    Returns:
    
    additionalAmount
  - setAdditionalAmount
```
public void setAdditionalAmount(Amount additionalAmount)
```
    additionalAmount
    
    Parameters:
    
    additionalAmount -
  - additionalData
```
public PaymentRequest 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 PaymentRequest instance, allowing for method chaining
  - putAdditionalDataItem
```
public PaymentRequest putAdditionalDataItem(String key,
                                            String additionalDataItem)
```
  - getAdditionalData
```
public Map<String,String> getAdditionalData()
```
    This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
    This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.
    
    Parameters:
    
    additionalData -
  - amount
```
public PaymentRequest amount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getAmount
```
public Amount getAmount()
```
    amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - applicationInfo
```
public PaymentRequest applicationInfo(ApplicationInfo applicationInfo)
```
    applicationInfo
    
    Parameters:
    
    applicationInfo -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
    applicationInfo
    
    Parameters:
    
    applicationInfo -
  - authenticationData
```
public PaymentRequest authenticationData(AuthenticationData authenticationData)
```
    authenticationData
    
    Parameters:
    
    authenticationData -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getAuthenticationData
```
public AuthenticationData getAuthenticationData()
```
    authenticationData
    
    Returns:
    
    authenticationData
  - setAuthenticationData
```
public void setAuthenticationData(AuthenticationData authenticationData)
```
    authenticationData
    
    Parameters:
    
    authenticationData -
  - bankAccount
```
public PaymentRequest bankAccount(CheckoutBankAccount bankAccount)
```
    bankAccount
    
    Parameters:
    
    bankAccount -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getBankAccount
```
public CheckoutBankAccount getBankAccount()
```
    bankAccount
    
    Returns:
    
    bankAccount
  - setBankAccount
```
public void setBankAccount(CheckoutBankAccount bankAccount)
```
    bankAccount
    
    Parameters:
    
    bankAccount -
  - billingAddress
```
public PaymentRequest billingAddress(BillingAddress billingAddress)
```
    billingAddress
    
    Parameters:
    
    billingAddress -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getBillingAddress
```
public BillingAddress getBillingAddress()
```
    billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(BillingAddress billingAddress)
```
    billingAddress
    
    Parameters:
    
    billingAddress -
  - browserInfo
```
public PaymentRequest browserInfo(BrowserInfo browserInfo)
```
    browserInfo
    
    Parameters:
    
    browserInfo -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getBrowserInfo
```
public BrowserInfo getBrowserInfo()
```
    browserInfo
    
    Returns:
    
    browserInfo
  - setBrowserInfo
```
public void setBrowserInfo(BrowserInfo browserInfo)
```
    browserInfo
    
    Parameters:
    
    browserInfo -
  - captureDelayHours
```
public PaymentRequest captureDelayHours(Integer captureDelayHours)
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Parameters:
    
    captureDelayHours -
    
    Returns:
    
    the current PaymentRequest 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 PaymentRequest channel(PaymentRequest.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 PaymentRequest instance, allowing for method chaining
  - getChannel
```
public PaymentRequest.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(PaymentRequest.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 PaymentRequest 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 PaymentRequest 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 PaymentRequest company(Company company)
```
    company
    
    Parameters:
    
    company -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getCompany
```
public Company getCompany()
```
    company
    
    Returns:
    
    company
  - setCompany
```
public void setCompany(Company company)
```
    company
    
    Parameters:
    
    company -
  - conversionId
```
@Deprecated
public PaymentRequest 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 PaymentRequest 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 PaymentRequest 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 PaymentRequest 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 PaymentRequest dateOfBirth(OffsetDateTime 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 PaymentRequest instance, allowing for method chaining
  - getDateOfBirth
```
public OffsetDateTime 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(OffsetDateTime dateOfBirth)
```
    The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD
    
    Parameters:
    
    dateOfBirth -
  - dccQuote
```
public PaymentRequest dccQuote(ForexQuote dccQuote)
```
    dccQuote
    
    Parameters:
    
    dccQuote -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getDccQuote
```
public ForexQuote getDccQuote()
```
    dccQuote
    
    Returns:
    
    dccQuote
  - setDccQuote
```
public void setDccQuote(ForexQuote dccQuote)
```
    dccQuote
    
    Parameters:
    
    dccQuote -
  - deliverAt
```
public PaymentRequest deliverAt(OffsetDateTime deliverAt)
```
    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:
    
    deliverAt -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getDeliverAt
```
public OffsetDateTime getDeliverAt()
```
    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:
    
    deliverAt
  - setDeliverAt
```
public void setDeliverAt(OffsetDateTime deliverAt)
```
    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:
    
    deliverAt -
  - deliveryAddress
```
public PaymentRequest deliveryAddress(DeliveryAddress deliveryAddress)
```
    deliveryAddress
    
    Parameters:
    
    deliveryAddress -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getDeliveryAddress
```
public DeliveryAddress getDeliveryAddress()
```
    deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(DeliveryAddress deliveryAddress)
```
    deliveryAddress
    
    Parameters:
    
    deliveryAddress -
  - deliveryDate
```
@Deprecated
public PaymentRequest deliveryDate(OffsetDateTime deliveryDate)
```
    Deprecated.
    since Adyen Checkout API v70 Use `deliverAt` instead.
    
    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 PaymentRequest instance, allowing for method chaining
  - getDeliveryDate
```
@Deprecated
public OffsetDateTime getDeliveryDate()
```
    Deprecated.
    since Adyen Checkout API v70 Use `deliverAt` instead.
    
    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
```
@Deprecated
public void setDeliveryDate(OffsetDateTime deliveryDate)
```
    Deprecated.
    since Adyen Checkout API v70 Use `deliverAt` instead.
    
    The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
    
    Parameters:
    
    deliveryDate -
  - deviceFingerprint
```
public PaymentRequest deviceFingerprint(String deviceFingerprint)
```
    A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
    
    Parameters:
    
    deviceFingerprint -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getDeviceFingerprint
```
public String getDeviceFingerprint()
```
    A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
    
    Returns:
    
    deviceFingerprint
  - setDeviceFingerprint
```
public void setDeviceFingerprint(String deviceFingerprint)
```
    A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
    
    Parameters:
    
    deviceFingerprint -
  - enableOneClick
```
public PaymentRequest 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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
    
    Parameters:
    
    enableOneClick -
    
    Returns:
    
    the current PaymentRequest 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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
    
    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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
    
    Parameters:
    
    enableOneClick -
  - enablePayOut
```
public PaymentRequest enablePayOut(Boolean enablePayOut)
```
    When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
    
    Parameters:
    
    enablePayOut -
    
    Returns:
    
    the current PaymentRequest 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 PaymentRequest enableRecurring(Boolean enableRecurring)
```
    When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
    
    Parameters:
    
    enableRecurring -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getEnableRecurring
```
public Boolean getEnableRecurring()
```
    When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
    
    Returns:
    
    enableRecurring
  - setEnableRecurring
```
public void setEnableRecurring(Boolean enableRecurring)
```
    When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
    
    Parameters:
    
    enableRecurring -
  - entityType
```
public PaymentRequest entityType(PaymentRequest.EntityTypeEnum entityType)
```
    The type of the entity the payment is processed for.
    
    Parameters:
    
    entityType -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getEntityType
```
public PaymentRequest.EntityTypeEnum getEntityType()
```
    The type of the entity the payment is processed for.
    
    Returns:
    
    entityType
  - setEntityType
```
public void setEntityType(PaymentRequest.EntityTypeEnum entityType)
```
    The type of the entity the payment is processed for.
    
    Parameters:
    
    entityType -
  - fraudOffset
```
public PaymentRequest 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 PaymentRequest 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 -
  - fundOrigin
```
public PaymentRequest fundOrigin(FundOrigin fundOrigin)
```
    fundOrigin
    
    Parameters:
    
    fundOrigin -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getFundOrigin
```
public FundOrigin getFundOrigin()
```
    fundOrigin
    
    Returns:
    
    fundOrigin
  - setFundOrigin
```
public void setFundOrigin(FundOrigin fundOrigin)
```
    fundOrigin
    
    Parameters:
    
    fundOrigin -
  - fundRecipient
```
public PaymentRequest fundRecipient(FundRecipient fundRecipient)
```
    fundRecipient
    
    Parameters:
    
    fundRecipient -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getFundRecipient
```
public FundRecipient getFundRecipient()
```
    fundRecipient
    
    Returns:
    
    fundRecipient
  - setFundRecipient
```
public void setFundRecipient(FundRecipient fundRecipient)
```
    fundRecipient
    
    Parameters:
    
    fundRecipient -
  - industryUsage
```
public PaymentRequest industryUsage(PaymentRequest.IndustryUsageEnum industryUsage)
```
    The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
    
    Parameters:
    
    industryUsage -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getIndustryUsage
```
public PaymentRequest.IndustryUsageEnum getIndustryUsage()
```
    The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
    
    Returns:
    
    industryUsage
  - setIndustryUsage
```
public void setIndustryUsage(PaymentRequest.IndustryUsageEnum industryUsage)
```
    The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**
    
    Parameters:
    
    industryUsage -
  - installments
```
public PaymentRequest installments(Installments installments)
```
    installments
    
    Parameters:
    
    installments -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getInstallments
```
public Installments getInstallments()
```
    installments
    
    Returns:
    
    installments
  - setInstallments
```
public void setInstallments(Installments installments)
```
    installments
    
    Parameters:
    
    installments -
  - lineItems
```
public PaymentRequest lineItems(List<LineItem> lineItems)
```
    Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, Riverty, and Zip.
    
    Parameters:
    
    lineItems -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - addLineItemsItem
```
public PaymentRequest addLineItemsItem(LineItem lineItemsItem)
```
  - getLineItems
```
public List<LineItem> getLineItems()
```
    Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, Riverty, and Zip.
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
    Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, Riverty, and Zip.
    
    Parameters:
    
    lineItems -
  - localizedShopperStatement
```
public PaymentRequest 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 PaymentRequest instance, allowing for method chaining
  - putLocalizedShopperStatementItem
```
public PaymentRequest 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 PaymentRequest mandate(Mandate mandate)
```
    mandate
    
    Parameters:
    
    mandate -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getMandate
```
public Mandate getMandate()
```
    mandate
    
    Returns:
    
    mandate
  - setMandate
```
public void setMandate(Mandate mandate)
```
    mandate
    
    Parameters:
    
    mandate -
  - mcc
```
public PaymentRequest 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 PaymentRequest 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 PaymentRequest merchantAccount(String merchantAccount)
```
    The merchant account identifier, with which you want to process the transaction.
    
    Parameters:
    
    merchantAccount -
    
    Returns:
    
    the current PaymentRequest 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 PaymentRequest 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 PaymentRequest 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 -
  - merchantRiskIndicator
```
public PaymentRequest merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
    merchantRiskIndicator
    
    Parameters:
    
    merchantRiskIndicator -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getMerchantRiskIndicator
```
public MerchantRiskIndicator getMerchantRiskIndicator()
```
    merchantRiskIndicator
    
    Returns:
    
    merchantRiskIndicator
  - setMerchantRiskIndicator
```
public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
    merchantRiskIndicator
    
    Parameters:
    
    merchantRiskIndicator -
  - metadata
```
public PaymentRequest 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 PaymentRequest instance, allowing for method chaining
  - putMetadataItem
```
public PaymentRequest 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 -
  - mpiData
```
public PaymentRequest mpiData(ThreeDSecureData mpiData)
```
    mpiData
    
    Parameters:
    
    mpiData -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getMpiData
```
public ThreeDSecureData getMpiData()
```
    mpiData
    
    Returns:
    
    mpiData
  - setMpiData
```
public void setMpiData(ThreeDSecureData mpiData)
```
    mpiData
    
    Parameters:
    
    mpiData -
  - order
```
public PaymentRequest order(EncryptedOrderData order)
```
    order
    
    Parameters:
    
    order -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getOrder
```
public EncryptedOrderData getOrder()
```
    order
    
    Returns:
    
    order
  - setOrder
```
public void setOrder(EncryptedOrderData order)
```
    order
    
    Parameters:
    
    order -
  - orderReference
```
public PaymentRequest 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 PaymentRequest 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 PaymentRequest origin(String origin)
```
    Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.
    
    Parameters:
    
    origin -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getOrigin
```
public String getOrigin()
```
    Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.
    
    Returns:
    
    origin
  - setOrigin
```
public void setOrigin(String origin)
```
    Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.
    
    Parameters:
    
    origin -
  - paymentMethod
```
public PaymentRequest paymentMethod(CheckoutPaymentMethod paymentMethod)
```
    paymentMethod
    
    Parameters:
    
    paymentMethod -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getPaymentMethod
```
public CheckoutPaymentMethod getPaymentMethod()
```
    paymentMethod
    
    Returns:
    
    paymentMethod
  - setPaymentMethod
```
public void setPaymentMethod(CheckoutPaymentMethod paymentMethod)
```
    paymentMethod
    
    Parameters:
    
    paymentMethod -
  - platformChargebackLogic
```
public PaymentRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getPlatformChargebackLogic
```
public PlatformChargebackLogic getPlatformChargebackLogic()
```
    platformChargebackLogic
    
    Returns:
    
    platformChargebackLogic
  - setPlatformChargebackLogic
```
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
```
    platformChargebackLogic
    
    Parameters:
    
    platformChargebackLogic -
  - recurringExpiry
```
public PaymentRequest recurringExpiry(String recurringExpiry)
```
    Date after which no further authorisations shall be performed. Only for 3D Secure 2.
    
    Parameters:
    
    recurringExpiry -
    
    Returns:
    
    the current PaymentRequest 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 PaymentRequest recurringFrequency(String recurringFrequency)
```
    Minimum number of days between authorisations. Only for 3D Secure 2.
    
    Parameters:
    
    recurringFrequency -
    
    Returns:
    
    the current PaymentRequest 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 -
  - recurringProcessingModel
```
public PaymentRequest recurringProcessingModel(PaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
    Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
    
    Parameters:
    
    recurringProcessingModel -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getRecurringProcessingModel
```
public PaymentRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
```
    Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
    
    Returns:
    
    recurringProcessingModel
  - setRecurringProcessingModel
```
public void setRecurringProcessingModel(PaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
    Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.
    
    Parameters:
    
    recurringProcessingModel -
  - redirectFromIssuerMethod
```
public PaymentRequest redirectFromIssuerMethod(String redirectFromIssuerMethod)
```
    Specifies the redirect method (GET or POST) when redirecting back from the issuer.
    
    Parameters:
    
    redirectFromIssuerMethod -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getRedirectFromIssuerMethod
```
public String getRedirectFromIssuerMethod()
```
    Specifies the redirect method (GET or POST) when redirecting back from the issuer.
    
    Returns:
    
    redirectFromIssuerMethod
  - setRedirectFromIssuerMethod
```
public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod)
```
    Specifies the redirect method (GET or POST) when redirecting back from the issuer.
    
    Parameters:
    
    redirectFromIssuerMethod -
  - redirectToIssuerMethod
```
public PaymentRequest redirectToIssuerMethod(String redirectToIssuerMethod)
```
    Specifies the redirect method (GET or POST) when redirecting to the issuer.
    
    Parameters:
    
    redirectToIssuerMethod -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getRedirectToIssuerMethod
```
public String getRedirectToIssuerMethod()
```
    Specifies the redirect method (GET or POST) when redirecting to the issuer.
    
    Returns:
    
    redirectToIssuerMethod
  - setRedirectToIssuerMethod
```
public void setRedirectToIssuerMethod(String redirectToIssuerMethod)
```
    Specifies the redirect method (GET or POST) when redirecting to the issuer.
    
    Parameters:
    
    redirectToIssuerMethod -
  - reference
```
public PaymentRequest 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 PaymentRequest 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 PaymentRequest returnUrl(String returnUrl)
```
    The URL to return to in case of a redirection. The format depends on the channel. * 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 PaymentRequest 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. * 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. * 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 PaymentRequest riskData(RiskData riskData)
```
    riskData
    
    Parameters:
    
    riskData -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getRiskData
```
public RiskData getRiskData()
```
    riskData
    
    Returns:
    
    riskData
  - setRiskData
```
public void setRiskData(RiskData riskData)
```
    riskData
    
    Parameters:
    
    riskData -
  - sessionValidity
```
public PaymentRequest 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 PaymentRequest 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 -
  - shopperConversionId
```
public PaymentRequest shopperConversionId(String shopperConversionId)
```
    A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
    
    Parameters:
    
    shopperConversionId -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getShopperConversionId
```
public String getShopperConversionId()
```
    A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
    
    Returns:
    
    shopperConversionId
  - setShopperConversionId
```
public void setShopperConversionId(String shopperConversionId)
```
    A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
    
    Parameters:
    
    shopperConversionId -
  - shopperEmail
```
public PaymentRequest 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 PaymentRequest 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 PaymentRequest 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 PaymentRequest 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 PaymentRequest shopperInteraction(PaymentRequest.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 PaymentRequest instance, allowing for method chaining
  - getShopperInteraction
```
public PaymentRequest.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(PaymentRequest.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 PaymentRequest 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 PaymentRequest 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 PaymentRequest shopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getShopperName
```
public Name getShopperName()
```
    shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
  - shopperReference
```
public PaymentRequest 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 PaymentRequest 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 PaymentRequest 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 PaymentRequest 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 PaymentRequest socialSecurityNumber(String socialSecurityNumber)
```
    The shopper's social security number.
    
    Parameters:
    
    socialSecurityNumber -
    
    Returns:
    
    the current PaymentRequest 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 PaymentRequest splits(List<Split> splits)
```
    An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    
    Parameters:
    
    splits -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - addSplitsItem
```
public PaymentRequest addSplitsItem(Split splitsItem)
```
  - getSplits
```
public List<Split> getSplits()
```
    An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    
    Returns:
    
    splits
  - setSplits
```
public void setSplits(List<Split> splits)
```
    An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
    
    Parameters:
    
    splits -
  - store
```
public PaymentRequest 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 PaymentRequest 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 PaymentRequest storePaymentMethod(Boolean storePaymentMethod)
```
    When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
    
    Parameters:
    
    storePaymentMethod -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getStorePaymentMethod
```
public Boolean getStorePaymentMethod()
```
    When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
    
    Returns:
    
    storePaymentMethod
  - setStorePaymentMethod
```
public void setStorePaymentMethod(Boolean storePaymentMethod)
```
    When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
    
    Parameters:
    
    storePaymentMethod -
  - subMerchants
```
public PaymentRequest subMerchants(List<SubMerchantInfo> subMerchants)
```
    This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
    
    Parameters:
    
    subMerchants -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - addSubMerchantsItem
```
public PaymentRequest addSubMerchantsItem(SubMerchantInfo subMerchantsItem)
```
  - getSubMerchants
```
public List<SubMerchantInfo> getSubMerchants()
```
    This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
    
    Returns:
    
    subMerchants
  - setSubMerchants
```
public void setSubMerchants(List<SubMerchantInfo> subMerchants)
```
    This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
    
    Parameters:
    
    subMerchants -
  - telephoneNumber
```
public PaymentRequest telephoneNumber(String telephoneNumber)
```
    The shopper's telephone number.
    
    Parameters:
    
    telephoneNumber -
    
    Returns:
    
    the current PaymentRequest 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 -
  - threeDS2RequestData
```
public PaymentRequest threeDS2RequestData(ThreeDS2RequestFields threeDS2RequestData)
```
    threeDS2RequestData
    
    Parameters:
    
    threeDS2RequestData -
    
    Returns:
    
    the current PaymentRequest instance, allowing for method chaining
  - getThreeDS2RequestData
```
public ThreeDS2RequestFields getThreeDS2RequestData()
```
    threeDS2RequestData
    
    Returns:
    
    threeDS2RequestData
  - setThreeDS2RequestData
```
public void setThreeDS2RequestData(ThreeDS2RequestFields threeDS2RequestData)
```
    threeDS2RequestData
    
    Parameters:
    
    threeDS2RequestData -
  - threeDSAuthenticationOnly
```
@Deprecated
public PaymentRequest 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 PaymentRequest 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 -
  - trustedShopper
```
public PaymentRequest trustedShopper(Boolean trustedShopper)
```
    Set to true if the payment should be routed to a trusted MID.
    
    Parameters:
    
    trustedShopper -
    
    Returns:
    
    the current PaymentRequest 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 PaymentRequest 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 PaymentRequest fromJson(String jsonString)
                               throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PaymentRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PaymentRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PaymentRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PaymentRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PaymentRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ACCOUNT_INFO

JSON_PROPERTY_ADDITIONAL_AMOUNT

JSON_PROPERTY_ADDITIONAL_DATA

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_APPLICATION_INFO

JSON_PROPERTY_AUTHENTICATION_DATA

JSON_PROPERTY_BANK_ACCOUNT

JSON_PROPERTY_BILLING_ADDRESS

JSON_PROPERTY_BROWSER_INFO

JSON_PROPERTY_CAPTURE_DELAY_HOURS

JSON_PROPERTY_CHANNEL

JSON_PROPERTY_CHECKOUT_ATTEMPT_ID

JSON_PROPERTY_COMPANY

JSON_PROPERTY_CONVERSION_ID

JSON_PROPERTY_COUNTRY_CODE

JSON_PROPERTY_DATE_OF_BIRTH

JSON_PROPERTY_DCC_QUOTE

JSON_PROPERTY_DELIVER_AT

JSON_PROPERTY_DELIVERY_ADDRESS

JSON_PROPERTY_DELIVERY_DATE

JSON_PROPERTY_DEVICE_FINGERPRINT

JSON_PROPERTY_ENABLE_ONE_CLICK

JSON_PROPERTY_ENABLE_PAY_OUT

JSON_PROPERTY_ENABLE_RECURRING

JSON_PROPERTY_ENTITY_TYPE

JSON_PROPERTY_FRAUD_OFFSET

JSON_PROPERTY_FUND_ORIGIN

JSON_PROPERTY_FUND_RECIPIENT

JSON_PROPERTY_INDUSTRY_USAGE

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_MERCHANT_RISK_INDICATOR

JSON_PROPERTY_METADATA

JSON_PROPERTY_MPI_DATA

JSON_PROPERTY_ORDER

JSON_PROPERTY_ORDER_REFERENCE

JSON_PROPERTY_ORIGIN

JSON_PROPERTY_PAYMENT_METHOD

JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC

JSON_PROPERTY_RECURRING_EXPIRY

JSON_PROPERTY_RECURRING_FREQUENCY

JSON_PROPERTY_RECURRING_PROCESSING_MODEL

JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD

JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_RETURN_URL

JSON_PROPERTY_RISK_DATA

JSON_PROPERTY_SESSION_VALIDITY

JSON_PROPERTY_SHOPPER_CONVERSION_ID

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_SUB_MERCHANTS

JSON_PROPERTY_TELEPHONE_NUMBER

JSON_PROPERTY_THREE_D_S2_REQUEST_DATA

JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY

JSON_PROPERTY_TRUSTED_SHOPPER

Constructor Detail

PaymentRequest

Method Detail