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

public class PaymentsRequest
extends Object

PaymentsRequest

Nested Class Summary

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

Constructor Summary

Constructors
Constructor Description

PaymentsRequest()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PaymentsRequest`	`accountInfo(AccountInfo accountInfo)`
`PaymentsRequest`	`additionalData(Map<String,String> additionalData)`
`PaymentsRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentsRequest`	`addSplitsItem(Split splitsItem)`
`PaymentsRequest`	`amount(Amount amount)`
`PaymentsRequest`	`applicationInfo(ApplicationInfo applicationInfo)`
`PaymentsRequest`	`authenticationData(AuthenticationData authenticationData)`
`PaymentsRequest`	`billingAddress(Address billingAddress)`
`PaymentsRequest`	`browserInfo(BrowserInfo browserInfo)`
`PaymentsRequest`	`captureDelayHours(Integer captureDelayHours)`
`PaymentsRequest`	`channel(PaymentsRequest.ChannelEnum channel)`
`PaymentsRequest`	`checkoutAttemptId(String checkoutAttemptId)`
`PaymentsRequest`	`company(Company company)`
`PaymentsRequest`	`conversionId(String conversionId)`
`PaymentsRequest`	`countryCode(String countryCode)`
`PaymentsRequest`	`dateOfBirth(Date dateOfBirth)`
`PaymentsRequest`	`dccQuote(ForexQuote dccQuote)`
`PaymentsRequest`	`deliveryAddress(Address deliveryAddress)`
`PaymentsRequest`	`deliveryDate(Date deliveryDate)`
`PaymentsRequest`	`deviceFingerprint(String deviceFingerprint)`
`PaymentsRequest`	`enableOneClick(Boolean enableOneClick)`
`PaymentsRequest`	`enablePayOut(Boolean enablePayOut)`
`PaymentsRequest`	`enableRecurring(Boolean enableRecurring)`
`PaymentsRequest`	`entityType(PaymentsRequest.EntityTypeEnum entityType)`
`boolean`	`equals(Object o)`
`PaymentsRequest`	`fraudOffset(Integer fraudOffset)`
`AccountInfo`	`getAccountInfo()`	Get accountInfo
`Map<String,String>`	`getAdditionalData()`	This field contains additional data, which may be required for a particular payment request.
`Amount`	`getAmount()`	Get amount
`ApplicationInfo`	`getApplicationInfo()`	Get applicationInfo
`AuthenticationData`	`getAuthenticationData()`	Get authenticationData
`Address`	`getBillingAddress()`	Get billingAddress
`BrowserInfo`	`getBrowserInfo()`	Get browserInfo
`Integer`	`getCaptureDelayHours()`	The delay between the authorisation and scheduled auto-capture, specified in hours.
`PaymentsRequest.ChannelEnum`	`getChannel()`	The platform where a payment transaction takes place.
`String`	`getCheckoutAttemptId()`	Checkout attempt ID that corresponds to the Id generated for tracking user payment journey.
`Company`	`getCompany()`	Get company
`String`	`getConversionId()`	Conversion ID that corresponds to the Id generated for tracking user payment journey.
`String`	`getCountryCode()`	The shopper country.
`Date`	`getDateOfBirth()`	The shopper's date of birth.
`ForexQuote`	`getDccQuote()`	Get dccQuote
`Address`	`getDeliveryAddress()`	Get deliveryAddress
`Date`	`getDeliveryDate()`	The date and time the purchased goods should be delivered.
`String`	`getDeviceFingerprint()`	A string containing the shopper's device fingerprint.
`PaymentsRequest.EntityTypeEnum`	`getEntityType()`	The type of the entity the payment is processed for.
`Integer`	`getFraudOffset()`	An integer value that is added to the normal fraud score.
`Installments`	`getInstallments()`	Get installments
`List<LineItem>`	`getLineItems()`	Price and product information about the purchased items, to be included on the invoice sent to the shopper.
`Mandate`	`getMandate()`	Get 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.
`MerchantRiskIndicator`	`getMerchantRiskIndicator()`	Get merchantRiskIndicator
`Map<String,String>`	`getMetadata()`	Metadata consists of entries, each of which includes a key and a value.
`ThreeDSecureData`	`getMpiData()`	Get mpiData
`CheckoutOrder`	`getOrder()`	Get 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.
`PaymentMethodDetails`	`getPaymentMethod()`	The type and required details of a payment method to use.
`String`	`getRecurringExpiry()`	Date after which no further authorisations shall be performed.
`String`	`getRecurringFrequency()`	Minimum number of days between authorisations.
`PaymentsRequest.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()`	Get 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`	`getShopperEmail()`	The shopper's email address.
`PaymentsRequest.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()`	Get shopperName
`String`	`getShopperReference()`	Required for recurring payments.
`String`	`getShopperStatement()`	The text to be shown on the shopper's bank statement.
`String`	`getSocialSecurityNumber()`	The shopper's social security number.
`List<Split>`	`getSplits()`	An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
`String`	`getStore()`	The ecommerce or point-of-sale store that is processing the payment.
`String`	`getTelephoneNumber()`	The shopper's telephone number.
`ThreeDS2RequestData`	`getThreeDS2RequestData()`	Get threeDS2RequestData
`int`	`hashCode()`
`PaymentsRequest`	`installments(Installments installments)`
`Boolean`	`isEnableOneClick()`	When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
`Boolean`	`isEnablePayOut()`	When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
`Boolean`	`isEnableRecurring()`	When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
`Boolean`	`isStorePaymentMethod()`	When true and `shopperReference` is provided, the payment details will be stored.
`Boolean`	`isThreeDSAuthenticationOnly()`	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.
`Boolean`	`isTrustedShopper()`	Set to true if the payment should be routed to a trusted MID.
`PaymentsRequest`	`lineItems(List<LineItem> lineItems)`
`PaymentsRequest`	`mandate(Mandate mandate)`
`PaymentsRequest`	`mcc(String mcc)`
`PaymentsRequest`	`merchantAccount(String merchantAccount)`
`PaymentsRequest`	`merchantOrderReference(String merchantOrderReference)`
`PaymentsRequest`	`merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)`
`PaymentsRequest`	`metadata(Map<String,String> metadata)`
`PaymentsRequest`	`mpiData(ThreeDSecureData mpiData)`
`PaymentsRequest`	`order(CheckoutOrder order)`
`PaymentsRequest`	`orderReference(String orderReference)`
`PaymentsRequest`	`origin(String origin)`
`PaymentsRequest`	`paymentMethod(PaymentMethodDetails paymentMethod)`
`PaymentsRequest`	`putAdditionalDataItem(String key, String additionalDataItem)`
`PaymentsRequest`	`putMetadataItem(String key, String metadataItem)`
`PaymentsRequest`	`recurringExpiry(String recurringExpiry)`
`PaymentsRequest`	`recurringFrequency(String recurringFrequency)`
`PaymentsRequest`	`recurringProcessingModel(PaymentsRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`PaymentsRequest`	`redirectFromIssuerMethod(String redirectFromIssuerMethod)`
`PaymentsRequest`	`redirectToIssuerMethod(String redirectToIssuerMethod)`
`PaymentsRequest`	`reference(String reference)`
`PaymentsRequest`	`returnUrl(String returnUrl)`
`PaymentsRequest`	`riskData(RiskData riskData)`
`PaymentsRequest`	`sessionValidity(String sessionValidity)`
`void`	`setAccountInfo(AccountInfo accountInfo)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAmount(Amount amount)`
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`
`void`	`setAuthenticationData(AuthenticationData authenticationData)`
`void`	`setBillingAddress(Address billingAddress)`
`void`	`setBrowserInfo(BrowserInfo browserInfo)`
`void`	`setCaptureDelayHours(Integer captureDelayHours)`
`void`	`setChannel(PaymentsRequest.ChannelEnum channel)`
`void`	`setCheckoutAttemptId(String checkoutAttemptId)`
`void`	`setCompany(Company company)`
`void`	`setConversionId(String conversionId)`
`void`	`setCountryCode(String countryCode)`
`void`	`setDateOfBirth(Date dateOfBirth)`
`void`	`setDccQuote(ForexQuote dccQuote)`
`void`	`setDeliveryAddress(Address deliveryAddress)`
`void`	`setDeliveryDate(Date deliveryDate)`
`void`	`setDeviceFingerprint(String deviceFingerprint)`
`void`	`setEnableOneClick(Boolean enableOneClick)`
`void`	`setEnablePayOut(Boolean enablePayOut)`
`void`	`setEnableRecurring(Boolean enableRecurring)`
`void`	`setEntityType(PaymentsRequest.EntityTypeEnum entityType)`
`void`	`setFraudOffset(Integer fraudOffset)`
`void`	`setInstallments(Installments installments)`
`void`	`setLineItems(List<LineItem> lineItems)`
`void`	`setMandate(Mandate mandate)`
`void`	`setMcc(String mcc)`
`void`	`setMerchantAccount(String merchantAccount)`
`void`	`setMerchantOrderReference(String merchantOrderReference)`
`void`	`setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)`
`void`	`setMetadata(Map<String,String> metadata)`
`void`	`setMpiData(ThreeDSecureData mpiData)`
`void`	`setOrder(CheckoutOrder order)`
`void`	`setOrderReference(String orderReference)`
`void`	`setOrigin(String origin)`
`void`	`setPaymentMethod(PaymentMethodDetails paymentMethod)`
`void`	`setRecurringExpiry(String recurringExpiry)`
`void`	`setRecurringFrequency(String recurringFrequency)`
`void`	`setRecurringProcessingModel(PaymentsRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`void`	`setRedirectFromIssuerMethod(String redirectFromIssuerMethod)`
`void`	`setRedirectToIssuerMethod(String redirectToIssuerMethod)`
`void`	`setReference(String reference)`
`void`	`setReturnUrl(String returnUrl)`
`void`	`setRiskData(RiskData riskData)`
`void`	`setSessionValidity(String sessionValidity)`
`void`	`setShopperEmail(String shopperEmail)`
`void`	`setShopperInteraction(PaymentsRequest.ShopperInteractionEnum shopperInteraction)`
`void`	`setShopperIP(String shopperIP)`
`void`	`setShopperLocale(String shopperLocale)`
`void`	`setShopperName(Name shopperName)`
`void`	`setShopperReference(String shopperReference)`
`void`	`setShopperStatement(String shopperStatement)`
`void`	`setSocialSecurityNumber(String socialSecurityNumber)`
`void`	`setSplits(List<Split> splits)`
`void`	`setStore(String store)`
`void`	`setStorePaymentMethod(Boolean storePaymentMethod)`
`void`	`setTelephoneNumber(String telephoneNumber)`
`void`	`setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)`
`void`	`setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`
`void`	`setTrustedShopper(Boolean trustedShopper)`
`PaymentsRequest`	`shopperEmail(String shopperEmail)`
`PaymentsRequest`	`shopperInteraction(PaymentsRequest.ShopperInteractionEnum shopperInteraction)`
`PaymentsRequest`	`shopperIP(String shopperIP)`
`PaymentsRequest`	`shopperLocale(String shopperLocale)`
`PaymentsRequest`	`shopperName(Name shopperName)`
`PaymentsRequest`	`shopperReference(String shopperReference)`
`PaymentsRequest`	`shopperStatement(String shopperStatement)`
`PaymentsRequest`	`socialSecurityNumber(String socialSecurityNumber)`
`PaymentsRequest`	`splits(List<Split> splits)`
`PaymentsRequest`	`store(String store)`
`PaymentsRequest`	`storePaymentMethod(Boolean storePaymentMethod)`
`PaymentsRequest`	`telephoneNumber(String telephoneNumber)`
`PaymentsRequest`	`threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)`
`PaymentsRequest`	`threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`
`String`	`toString()`
`PaymentsRequest`	`trustedShopper(Boolean trustedShopper)`

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

- Constructor Detail
  - PaymentsRequest
```
public PaymentsRequest()
```
- Method Detail
  - accountInfo
```
public PaymentsRequest accountInfo(AccountInfo accountInfo)
```
  - getAccountInfo
```
public AccountInfo getAccountInfo()
```
    Get accountInfo
    
    Returns:
    
    accountInfo
  - setAccountInfo
```
public void setAccountInfo(AccountInfo accountInfo)
```
  - additionalData
```
public PaymentsRequest additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public PaymentsRequest 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)
```
  - amount
```
public PaymentsRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - applicationInfo
```
public PaymentsRequest applicationInfo(ApplicationInfo applicationInfo)
```
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    Get applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
  - authenticationData
```
public PaymentsRequest authenticationData(AuthenticationData authenticationData)
```
  - getAuthenticationData
```
public AuthenticationData getAuthenticationData()
```
    Get authenticationData
    
    Returns:
    
    authenticationData
  - setAuthenticationData
```
public void setAuthenticationData(AuthenticationData authenticationData)
```
  - billingAddress
```
public PaymentsRequest billingAddress(Address billingAddress)
```
  - getBillingAddress
```
public Address getBillingAddress()
```
    Get billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
  - browserInfo
```
public PaymentsRequest browserInfo(BrowserInfo browserInfo)
```
  - getBrowserInfo
```
public BrowserInfo getBrowserInfo()
```
    Get browserInfo
    
    Returns:
    
    browserInfo
  - setBrowserInfo
```
public void setBrowserInfo(BrowserInfo browserInfo)
```
  - captureDelayHours
```
public PaymentsRequest captureDelayHours(Integer captureDelayHours)
```
  - getCaptureDelayHours
```
public Integer getCaptureDelayHours()
```
    The delay between the authorisation and scheduled auto-capture, specified in hours.
    
    Returns:
    
    captureDelayHours
  - setCaptureDelayHours
```
public void setCaptureDelayHours(Integer captureDelayHours)
```
  - channel
```
public PaymentsRequest channel(PaymentsRequest.ChannelEnum channel)
```
  - getChannel
```
public PaymentsRequest.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(PaymentsRequest.ChannelEnum channel)
```
  - checkoutAttemptId
```
public PaymentsRequest checkoutAttemptId(String checkoutAttemptId)
```
  - getCheckoutAttemptId
```
public String getCheckoutAttemptId()
```
    Checkout attempt ID that corresponds to the Id generated for tracking user payment journey.
    
    Returns:
    
    checkoutAttemptId
  - setCheckoutAttemptId
```
public void setCheckoutAttemptId(String checkoutAttemptId)
```
  - company
```
public PaymentsRequest company(Company company)
```
  - getCompany
```
public Company getCompany()
```
    Get company
    
    Returns:
    
    company
  - setCompany
```
public void setCompany(Company company)
```
  - conversionId
```
public PaymentsRequest conversionId(String conversionId)
```
  - getConversionId
```
public String getConversionId()
```
    Conversion ID that corresponds to the Id generated for tracking user payment journey.
    
    Returns:
    
    conversionId
  - setConversionId
```
public void setConversionId(String conversionId)
```
  - countryCode
```
public PaymentsRequest countryCode(String countryCode)
```
  - 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)
```
  - dateOfBirth
```
public PaymentsRequest dateOfBirth(Date dateOfBirth)
```
  - getDateOfBirth
```
public Date 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(Date dateOfBirth)
```
  - dccQuote
```
public PaymentsRequest dccQuote(ForexQuote dccQuote)
```
  - getDccQuote
```
public ForexQuote getDccQuote()
```
    Get dccQuote
    
    Returns:
    
    dccQuote
  - setDccQuote
```
public void setDccQuote(ForexQuote dccQuote)
```
  - deliveryAddress
```
public PaymentsRequest deliveryAddress(Address deliveryAddress)
```
  - getDeliveryAddress
```
public Address getDeliveryAddress()
```
    Get deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(Address deliveryAddress)
```
  - deliveryDate
```
public PaymentsRequest deliveryDate(Date deliveryDate)
```
  - getDeliveryDate
```
public Date getDeliveryDate()
```
    The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00
    
    Returns:
    
    deliveryDate
  - setDeliveryDate
```
public void setDeliveryDate(Date deliveryDate)
```
  - deviceFingerprint
```
public PaymentsRequest deviceFingerprint(String deviceFingerprint)
```
  - getDeviceFingerprint
```
public String getDeviceFingerprint()
```
    A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
    
    Returns:
    
    deviceFingerprint
  - setDeviceFingerprint
```
public void setDeviceFingerprint(String deviceFingerprint)
```
  - enableOneClick
```
public PaymentsRequest enableOneClick(Boolean enableOneClick)
```
  - isEnableOneClick
```
public Boolean isEnableOneClick()
```
    When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
    
    Returns:
    
    enableOneClick
  - setEnableOneClick
```
public void setEnableOneClick(Boolean enableOneClick)
```
  - enablePayOut
```
public PaymentsRequest enablePayOut(Boolean enablePayOut)
```
  - isEnablePayOut
```
public Boolean isEnablePayOut()
```
    When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
    
    Returns:
    
    enablePayOut
  - setEnablePayOut
```
public void setEnablePayOut(Boolean enablePayOut)
```
  - enableRecurring
```
public PaymentsRequest enableRecurring(Boolean enableRecurring)
```
  - isEnableRecurring
```
public Boolean isEnableRecurring()
```
    When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
    
    Returns:
    
    enableRecurring
  - setEnableRecurring
```
public void setEnableRecurring(Boolean enableRecurring)
```
  - entityType
```
public PaymentsRequest entityType(PaymentsRequest.EntityTypeEnum entityType)
```
  - getEntityType
```
public PaymentsRequest.EntityTypeEnum getEntityType()
```
    The type of the entity the payment is processed for.
    
    Returns:
    
    entityType
  - setEntityType
```
public void setEntityType(PaymentsRequest.EntityTypeEnum entityType)
```
  - fraudOffset
```
public PaymentsRequest fraudOffset(Integer fraudOffset)
```
  - getFraudOffset
```
public Integer getFraudOffset()
```
    An integer value that is added to the normal fraud score. The value can be either positive or negative.
    
    Returns:
    
    fraudOffset
  - setFraudOffset
```
public void setFraudOffset(Integer fraudOffset)
```
  - installments
```
public PaymentsRequest installments(Installments installments)
```
  - getInstallments
```
public Installments getInstallments()
```
    Get installments
    
    Returns:
    
    installments
  - setInstallments
```
public void setInstallments(Installments installments)
```
  - lineItems
```
public PaymentsRequest lineItems(List<LineItem> lineItems)
```
  - addLineItemsItem
```
public PaymentsRequest 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, Zip and Atome.
    
    Returns:
    
    lineItems
  - setLineItems
```
public void setLineItems(List<LineItem> lineItems)
```
  - mandate
```
public PaymentsRequest mandate(Mandate mandate)
```
  - getMandate
```
public Mandate getMandate()
```
    Get mandate
    
    Returns:
    
    mandate
  - setMandate
```
public void setMandate(Mandate mandate)
```
  - mcc
```
public PaymentsRequest mcc(String mcc)
```
  - getMcc
```
public String getMcc()
```
    The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
    
    Returns:
    
    mcc
  - setMcc
```
public void setMcc(String mcc)
```
  - merchantAccount
```
public PaymentsRequest merchantAccount(String merchantAccount)
```
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account identifier, with which you want to process the transaction.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
  - merchantOrderReference
```
public PaymentsRequest merchantOrderReference(String merchantOrderReference)
```
  - getMerchantOrderReference
```
public String getMerchantOrderReference()
```
    This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `paymentsRequest.additionalData`.
    
    Returns:
    
    merchantOrderReference
  - setMerchantOrderReference
```
public void setMerchantOrderReference(String merchantOrderReference)
```
  - merchantRiskIndicator
```
public PaymentsRequest merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
  - getMerchantRiskIndicator
```
public MerchantRiskIndicator getMerchantRiskIndicator()
```
    Get merchantRiskIndicator
    
    Returns:
    
    merchantRiskIndicator
  - setMerchantRiskIndicator
```
public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
  - metadata
```
public PaymentsRequest metadata(Map<String,String> metadata)
```
  - putMetadataItem
```
public PaymentsRequest 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)
```
  - mpiData
```
public PaymentsRequest mpiData(ThreeDSecureData mpiData)
```
  - getMpiData
```
public ThreeDSecureData getMpiData()
```
    Get mpiData
    
    Returns:
    
    mpiData
  - setMpiData
```
public void setMpiData(ThreeDSecureData mpiData)
```
  - order
```
public PaymentsRequest order(CheckoutOrder order)
```
  - getOrder
```
public CheckoutOrder getOrder()
```
    Get order
    
    Returns:
    
    order
  - setOrder
```
public void setOrder(CheckoutOrder order)
```
  - orderReference
```
public PaymentsRequest orderReference(String orderReference)
```
  - getOrderReference
```
public String getOrderReference()
```
    When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
    
    Returns:
    
    orderReference
  - setOrderReference
```
public void setOrderReference(String orderReference)
```
  - origin
```
public PaymentsRequest origin(String origin)
```
  - 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)
```
  - paymentMethod
```
public PaymentsRequest paymentMethod(PaymentMethodDetails paymentMethod)
```
  - getPaymentMethod
```
public PaymentMethodDetails getPaymentMethod()
```
    The type and required details of a payment method to use.
    
    Returns:
    
    paymentMethod
  - setPaymentMethod
```
public void setPaymentMethod(PaymentMethodDetails paymentMethod)
```
  - recurringExpiry
```
public PaymentsRequest recurringExpiry(String recurringExpiry)
```
  - 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)
```
  - recurringFrequency
```
public PaymentsRequest recurringFrequency(String recurringFrequency)
```
  - getRecurringFrequency
```
public String getRecurringFrequency()
```
    Minimum number of days between authorisations. Only for 3D Secure 2.
    
    Returns:
    
    recurringFrequency
  - setRecurringFrequency
```
public void setRecurringFrequency(String recurringFrequency)
```
  - recurringProcessingModel
```
public PaymentsRequest recurringProcessingModel(PaymentsRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - getRecurringProcessingModel
```
public PaymentsRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
```
    Defines a recurring payment type. 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(PaymentsRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - redirectFromIssuerMethod
```
public PaymentsRequest redirectFromIssuerMethod(String redirectFromIssuerMethod)
```
  - 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)
```
  - redirectToIssuerMethod
```
public PaymentsRequest redirectToIssuerMethod(String redirectToIssuerMethod)
```
  - getRedirectToIssuerMethod
```
public String getRedirectToIssuerMethod()
```
    Specifies the redirect method (GET or POST) when redirecting to the issuer.
    
    Returns:
    
    redirectToIssuerMethod
  - setRedirectToIssuerMethod
```
public void setRedirectToIssuerMethod(String redirectToIssuerMethod)
```
  - reference
```
public PaymentsRequest reference(String reference)
```
  - getReference
```
public String getReference()
```
    The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
  - returnUrl
```
public PaymentsRequest returnUrl(String returnUrl)
```
  - getReturnUrl
```
public String getReturnUrl()
```
    The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`
    
    Returns:
    
    returnUrl
  - setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
  - riskData
```
public PaymentsRequest riskData(RiskData riskData)
```
  - getRiskData
```
public RiskData getRiskData()
```
    Get riskData
    
    Returns:
    
    riskData
  - setRiskData
```
public void setRiskData(RiskData riskData)
```
  - sessionValidity
```
public PaymentsRequest sessionValidity(String sessionValidity)
```
  - 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)
```
  - shopperEmail
```
public PaymentsRequest shopperEmail(String shopperEmail)
```
  - getShopperEmail
```
public String getShopperEmail()
```
    The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.
    
    Returns:
    
    shopperEmail
  - setShopperEmail
```
public void setShopperEmail(String shopperEmail)
```
  - shopperIP
```
public PaymentsRequest shopperIP(String shopperIP)
```
  - getShopperIP
```
public String getShopperIP()
```
    The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).
    
    Returns:
    
    shopperIP
  - setShopperIP
```
public void setShopperIP(String shopperIP)
```
  - shopperInteraction
```
public PaymentsRequest shopperInteraction(PaymentsRequest.ShopperInteractionEnum shopperInteraction)
```
  - getShopperInteraction
```
public PaymentsRequest.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(PaymentsRequest.ShopperInteractionEnum shopperInteraction)
```
  - shopperLocale
```
public PaymentsRequest shopperLocale(String shopperLocale)
```
  - getShopperLocale
```
public String getShopperLocale()
```
    The combination of a language code and a country code to specify the language to be used in the payment.
    
    Returns:
    
    shopperLocale
  - setShopperLocale
```
public void setShopperLocale(String shopperLocale)
```
  - shopperName
```
public PaymentsRequest shopperName(Name shopperName)
```
  - getShopperName
```
public Name getShopperName()
```
    Get shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
  - shopperReference
```
public PaymentsRequest shopperReference(String shopperReference)
```
  - getShopperReference
```
public String getShopperReference()
```
    Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
  - shopperStatement
```
public PaymentsRequest shopperStatement(String shopperStatement)
```
  - getShopperStatement
```
public String getShopperStatement()
```
    The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**.
    
    Returns:
    
    shopperStatement
  - setShopperStatement
```
public void setShopperStatement(String shopperStatement)
```
  - socialSecurityNumber
```
public PaymentsRequest socialSecurityNumber(String socialSecurityNumber)
```
  - getSocialSecurityNumber
```
public String getSocialSecurityNumber()
```
    The shopper's social security number.
    
    Returns:
    
    socialSecurityNumber
  - setSocialSecurityNumber
```
public void setSocialSecurityNumber(String socialSecurityNumber)
```
  - splits
```
public PaymentsRequest splits(List<Split> splits)
```
  - addSplitsItem
```
public PaymentsRequest addSplitsItem(Split splitsItem)
```
  - getSplits
```
public List<Split> getSplits()
```
    An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/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)
```
  - store
```
public PaymentsRequest store(String store)
```
  - getStore
```
public String getStore()
```
    The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.
    
    Returns:
    
    store
  - setStore
```
public void setStore(String store)
```
  - storePaymentMethod
```
public PaymentsRequest storePaymentMethod(Boolean storePaymentMethod)
```
  - isStorePaymentMethod
```
public Boolean isStorePaymentMethod()
```
    When true and `shopperReference` is provided, the payment details will be stored.
    
    Returns:
    
    storePaymentMethod
  - setStorePaymentMethod
```
public void setStorePaymentMethod(Boolean storePaymentMethod)
```
  - telephoneNumber
```
public PaymentsRequest telephoneNumber(String telephoneNumber)
```
  - getTelephoneNumber
```
public String getTelephoneNumber()
```
    The shopper's telephone number.
    
    Returns:
    
    telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(String telephoneNumber)
```
  - threeDS2RequestData
```
public PaymentsRequest threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
```
  - getThreeDS2RequestData
```
public ThreeDS2RequestData getThreeDS2RequestData()
```
    Get threeDS2RequestData
    
    Returns:
    
    threeDS2RequestData
  - setThreeDS2RequestData
```
public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
```
  - threeDSAuthenticationOnly
```
public PaymentsRequest threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
```
  - isThreeDSAuthenticationOnly
```
public Boolean isThreeDSAuthenticationOnly()
```
    If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
    
    Returns:
    
    threeDSAuthenticationOnly
  - setThreeDSAuthenticationOnly
```
public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
```
  - trustedShopper
```
public PaymentsRequest trustedShopper(Boolean trustedShopper)
```
  - isTrustedShopper
```
public Boolean isTrustedShopper()
```
    Set to true if the payment should be routed to a trusted MID.
    
    Returns:
    
    trustedShopper
  - setTrustedShopper
```
public void setTrustedShopper(Boolean trustedShopper)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PaymentsRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PaymentsRequest

Method Detail

accountInfo

getAccountInfo

setAccountInfo

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

amount

getAmount

setAmount

applicationInfo

getApplicationInfo

setApplicationInfo

authenticationData

getAuthenticationData

setAuthenticationData

billingAddress

getBillingAddress

setBillingAddress

browserInfo

getBrowserInfo

setBrowserInfo

captureDelayHours

getCaptureDelayHours

setCaptureDelayHours

channel

getChannel

setChannel

checkoutAttemptId

getCheckoutAttemptId

setCheckoutAttemptId

company

getCompany

setCompany

conversionId

getConversionId

setConversionId

countryCode

getCountryCode

setCountryCode

dateOfBirth

getDateOfBirth

setDateOfBirth

dccQuote

getDccQuote

setDccQuote

deliveryAddress

getDeliveryAddress

setDeliveryAddress

deliveryDate

getDeliveryDate

setDeliveryDate

deviceFingerprint

getDeviceFingerprint

setDeviceFingerprint

enableOneClick

isEnableOneClick

setEnableOneClick

enablePayOut

isEnablePayOut

setEnablePayOut

enableRecurring

isEnableRecurring

setEnableRecurring

entityType

getEntityType

setEntityType

fraudOffset

getFraudOffset

setFraudOffset

installments

getInstallments