PaymentsRequest (Adyen Java API Library 17.3.0 API)

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

public class PaymentsRequest
extends Object

PaymentsRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class and 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` how the shopper interacts with the system
`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 and Description

PaymentsRequest()

Constructors
Constructor and Description
`PaymentsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PaymentsRequest`	`addBrowserInfoData(String userAgent, String acceptHeader)`
`PaymentsRequest`	`addCardData(String cardNumber, String expiryMonth, String expiryYear, String securityCode, String holderName)` Add raw card data into the payment request.
`PaymentsRequest`	`addCardData(String cardNumber, String expiryMonth, String expiryYear, String securityCode, String holderName, Boolean storeDetails)`
`PaymentsRequest`	`addEncryptedCardData(String encryptedCardNumber, String encryptedExpiryMonth, String encryptedExpiryYear, String encryptedSecurityCode)`
`PaymentsRequest`	`addEncryptedCardData(String encryptedCardNumber, String encryptedExpiryMonth, String encryptedExpiryYear, String encryptedSecurityCode, String holderName)`
`PaymentsRequest`	`addEncryptedCardData(String encryptedCardNumber, String encryptedExpiryMonth, String encryptedExpiryYear, String encryptedSecurityCode, String holderName, Boolean storeDetails)`
`PaymentsRequest`	`additionalData(Map<String,String> additionalData)`
`PaymentsRequest`	`addLineItemsItem(LineItem lineItemsItem)`
`PaymentsRequest`	`addOneClickData(String recurringDetailReference, String encryptedSecurityCode)`
`PaymentsRequest`	`amount(Amount amount)`
`PaymentsRequest`	`applicationInfo(ApplicationInfo applicationInfo)`
`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()`
`Map<String,String>`	`getAdditionalData()` This field contains additional data, which may be required for a particular payment request.
`Amount`	`getAmount()` Get amount
`ApplicationInfo`	`getApplicationInfo()`
`Address`	`getBillingAddress()` Get billingAddress
`BrowserInfo`	`getBrowserInfo()`
`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()`
`Boolean`	`getEnableOneClick()`
`Boolean`	`getEnablePayOut()`
`Boolean`	`getEnableRecurring()`
`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()` Line items regarding the payment.
`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.
`MerchantRiskIndicator`	`getMerchantRiskIndicator()`
`Map<String,String>`	`getMetadata()` Metadata consists of entries, each of which includes a key and a value.
`ThreeDSecureData`	`getMpiData()` Authentication data produced by an MPI (Mastercard SecureCode or Verified By Visa).
`CheckoutOrder`	`getOrder()` Contains the order information which is required for partial payments.
`String`	`getOrderReference()` The order reference to link multiple partial payments.
`String`	`getOrigin()`
`PaymentMethodDetails`	`getPaymentMethod()`
`String`	`getRecurringExpiry()`
`String`	`getRecurringFrequency()`
`PaymentsRequest.RecurringProcessingModelEnum`	`getRecurringProcessingModel()`
`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.
`RiskData`	`getRiskData()` Get riskData
`String`	`getSessionValidity()` The maximum validity of the session.
`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()` The shopper's reference to uniquely identify this shopper (e.g.
`String`	`getShopperStatement()` The text to appear on the shopper's bank statement.
`String`	`getSocialSecurityNumber()` The shopper's social security number.
`List<Split>`	`getSplits()`
`String`	`getStore()`
`Boolean`	`getStorePaymentMethod()` When true and shopperReference is provided, the payment details will be stored.
`String`	`getTelephoneNumber()` The shopper's telephone number.
`ThreeDS2RequestData`	`getThreeDS2RequestData()`
`Boolean`	`getTrustedShopper()`
`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`	`isThreeDSAuthenticationOnly()` If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.
`PaymentsRequest`	`lineItems(List<LineItem> lineItems)`
`PaymentsRequest`	`mandate(Mandate mandate)`
`PaymentsRequest`	`mcc(String mcc)`
`PaymentsRequest`	`merchantAccount(String merchantAccount)`
`PaymentsRequest`	`merchantOrderReference(String merchantOrderReference)`
`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`	`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)`
`PaymentsRequest`	`setAmountData(String amount, String currency)`
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`
`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`	`store(String store)`
`PaymentsRequest`	`storePaymentMethod(Boolean storePaymentMethod)`
`PaymentsRequest`	`telephoneNumber(String telephoneNumber)`
`PaymentsRequest`	`threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`
`String`	`toString()`

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

Constructor Detail
- PaymentsRequest
```
public PaymentsRequest()
```

Method Detail

getRecurringProcessingModel

public PaymentsRequest.RecurringProcessingModelEnum getRecurringProcessingModel()

recurringProcessingModel

public PaymentsRequest recurringProcessingModel(PaymentsRequest.RecurringProcessingModelEnum recurringProcessingModel)

setRecurringProcessingModel

public void setRecurringProcessingModel(PaymentsRequest.RecurringProcessingModelEnum recurringProcessingModel)

getMerchantRiskIndicator

public MerchantRiskIndicator getMerchantRiskIndicator()

setMerchantRiskIndicator

public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)

getAccountInfo
```
public AccountInfo getAccountInfo()
```

setAccountInfo

public void setAccountInfo(AccountInfo accountInfo)

getEnableOneClick
```
public Boolean getEnableOneClick()
```

getEnablePayOut
```
public Boolean getEnablePayOut()
```

getEnableRecurring
```
public Boolean getEnableRecurring()
```

getSplits
```
public List<Split> getSplits()
```

setSplits

public void setSplits(List<Split> splits)

getTrustedShopper
```
public Boolean getTrustedShopper()
```

setTrustedShopper

public void setTrustedShopper(Boolean trustedShopper)

getThreeDS2RequestData

public ThreeDS2RequestData getThreeDS2RequestData()

setThreeDS2RequestData

public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)

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. For more information on possible key-value pairs, refer to the [additionalData section](https://docs.adyen.com/developers/api-reference/payments-api#paymentrequestadditionaldata).

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)
```

setAmountData

public PaymentsRequest setAmountData(String amount,
                                     String currency)

billingAddress

public PaymentsRequest billingAddress(Address billingAddress)

getBillingAddress
```
public Address getBillingAddress()
```
Get billingAddress

Returns:

billingAddress

setBillingAddress

public void setBillingAddress(Address billingAddress)

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)

company

public PaymentsRequest company(Company company)

getCompany
```
public Company getCompany()
```
Get company

Returns:

company

setCompany

public void setCompany(Company company)

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)

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()
```
Line items regarding the payment.

Returns:

lineItems

setLineItems

public void setLineItems(List<LineItem> lineItems)

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. > When providing the `merchantOrderReference` value, we also recommend you submit `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values.

Returns:

merchantOrderReference

setMerchantOrderReference

public void setMerchantOrderReference(String merchantOrderReference)

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. Limitations: Error \"177\", \"Metadata size exceeds limit\"

Returns:

metadata

setMetadata

public void setMetadata(Map<String,String> metadata)

orderReference

public PaymentsRequest orderReference(String orderReference)

getOrderReference
```
public String getOrderReference()
```
The order reference to link multiple partial payments.

Returns:

orderReference

setOrderReference

public void setOrderReference(String orderReference)

getPaymentMethod

public PaymentMethodDetails getPaymentMethod()

setPaymentMethod

public void setPaymentMethod(PaymentMethodDetails paymentMethod)

paymentMethod

public PaymentsRequest paymentMethod(PaymentMethodDetails paymentMethod)

getStore
```
public String getStore()
```

setStore
```
public void setStore(String store)
```

store

public PaymentsRequest store(String store)

mandate

public PaymentsRequest mandate(Mandate mandate)

getMandate
```
public Mandate getMandate()
```
Get mandate

Returns:

mandate

setMandate

public void setMandate(Mandate mandate)

addEncryptedCardData

public PaymentsRequest addEncryptedCardData(String encryptedCardNumber,
                                            String encryptedExpiryMonth,
                                            String encryptedExpiryYear,
                                            String encryptedSecurityCode)

addEncryptedCardData

public PaymentsRequest addEncryptedCardData(String encryptedCardNumber,
                                            String encryptedExpiryMonth,
                                            String encryptedExpiryYear,
                                            String encryptedSecurityCode,
                                            String holderName)

addEncryptedCardData

public PaymentsRequest addEncryptedCardData(String encryptedCardNumber,
                                            String encryptedExpiryMonth,
                                            String encryptedExpiryYear,
                                            String encryptedSecurityCode,
                                            String holderName,
                                            Boolean storeDetails)

addCardData

public PaymentsRequest addCardData(String cardNumber,
                                   String expiryMonth,
                                   String expiryYear,
                                   String securityCode,
                                   String holderName)

Add raw card data into the payment request. You need to be PCI compliant!

Parameters:: cardNumber - card number; expiryMonth - expiry month; expiryYear - expiry year; holderName - holder name; securityCode - security code
Returns:: paymentMethod payment method

addCardData

public PaymentsRequest addCardData(String cardNumber,
                                   String expiryMonth,
                                   String expiryYear,
                                   String securityCode,
                                   String holderName,
                                   Boolean storeDetails)

addOneClickData

public PaymentsRequest addOneClickData(String recurringDetailReference,
                                       String encryptedSecurityCode)

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.

Returns:

returnUrl

setReturnUrl

public void setReturnUrl(String returnUrl)

sessionValidity

public PaymentsRequest sessionValidity(String sessionValidity)

getSessionValidity
```
public String getSessionValidity()
```
The maximum validity of the session.

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.

Returns:

shopperEmail

setShopperEmail

public void setShopperEmail(String shopperEmail)

shopperIP

public PaymentsRequest shopperIP(String shopperIP)

getShopperIP
```
public String getShopperIP()
```
The shopper's IP address. 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). > This field is 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()
```
The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). > This field is required for recurring payments.

Returns:

shopperReference

setShopperReference

public void setShopperReference(String shopperReference)

shopperStatement

public PaymentsRequest shopperStatement(String shopperStatement)

getShopperStatement
```
public String getShopperStatement()
```
The text to appear on the shopper's bank statement.

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)

telephoneNumber

public PaymentsRequest telephoneNumber(String telephoneNumber)

getTelephoneNumber
```
public String getTelephoneNumber()
```
The shopper's telephone number.

Returns:

telephoneNumber

setTelephoneNumber

public void setTelephoneNumber(String telephoneNumber)

getBrowserInfo
```
public BrowserInfo getBrowserInfo()
```

setBrowserInfo

public void setBrowserInfo(BrowserInfo browserInfo)

browserInfo

public PaymentsRequest browserInfo(BrowserInfo browserInfo)

addBrowserInfoData

public PaymentsRequest addBrowserInfoData(String userAgent,
                                          String acceptHeader)

getDeviceFingerprint
```
public String getDeviceFingerprint()
```

setDeviceFingerprint

public void setDeviceFingerprint(String deviceFingerprint)

deviceFingerprint

public PaymentsRequest deviceFingerprint(String deviceFingerprint)

getApplicationInfo

public ApplicationInfo getApplicationInfo()

setApplicationInfo

public void setApplicationInfo(ApplicationInfo applicationInfo)

applicationInfo

public PaymentsRequest applicationInfo(ApplicationInfo applicationInfo)

getOrigin
```
public String getOrigin()
```

setOrigin
```
public void setOrigin(String origin)
```

origin

public PaymentsRequest origin(String origin)

getMpiData
```
public ThreeDSecureData getMpiData()
```
Authentication data produced by an MPI (Mastercard SecureCode or Verified By Visa).

Returns:

the mpi data

setMpiData

public void setMpiData(ThreeDSecureData mpiData)

mpiData

public PaymentsRequest mpiData(ThreeDSecureData mpiData)

getRedirectFromIssuerMethod
```
public String getRedirectFromIssuerMethod()
```
Specifies the redirect method (GET or POST) when redirecting back from the issuer.

Returns:

the redirect from issuer method

setRedirectFromIssuerMethod

public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod)

redirectFromIssuerMethod

public PaymentsRequest redirectFromIssuerMethod(String redirectFromIssuerMethod)

getRedirectToIssuerMethod
```
public String getRedirectToIssuerMethod()
```
Specifies the redirect method (GET or POST) when redirecting to the issuer.

Returns:

the redirect to issuer method

setRedirectToIssuerMethod

public void setRedirectToIssuerMethod(String redirectToIssuerMethod)

redirectToIssuerMethod

public PaymentsRequest redirectToIssuerMethod(String redirectToIssuerMethod)

getOrder
```
public CheckoutOrder getOrder()
```
Contains the order information which is required for partial payments.

Returns:

order

setOrder

public void setOrder(CheckoutOrder order)

order

public PaymentsRequest order(CheckoutOrder order)

getStorePaymentMethod
```
public Boolean getStorePaymentMethod()
```
When true and shopperReference is provided, the payment details will be stored.

Returns:

storePaymentMethod

setStorePaymentMethod

public void setStorePaymentMethod(Boolean storePaymentMethod)

storePaymentMethod

public PaymentsRequest storePaymentMethod(Boolean storePaymentMethod)

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/checkout/3d-secure/native-3ds2/authentication-only), and not the payment authorisation.

Returns:

threeDSAuthenticationOnly

setThreeDSAuthenticationOnly

public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)

riskData

public PaymentsRequest riskData(RiskData riskData)

getRiskData
```
public RiskData getRiskData()
```
Get riskData

Returns:

riskData

setRiskData

public void setRiskData(RiskData riskData)

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)

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)

getRecurringExpiry
```
public String getRecurringExpiry()
```

setRecurringExpiry

public void setRecurringExpiry(String recurringExpiry)

getRecurringFrequency
```
public String getRecurringFrequency()
```

setRecurringFrequency

public void setRecurringFrequency(String recurringFrequency)

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

getRecurringProcessingModel

recurringProcessingModel

setRecurringProcessingModel

getMerchantRiskIndicator

setMerchantRiskIndicator

getAccountInfo

setAccountInfo

getEnableOneClick

getEnablePayOut

getEnableRecurring

getSplits

setSplits

getTrustedShopper

setTrustedShopper

getThreeDS2RequestData

setThreeDS2RequestData

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

amount

getAmount

setAmount

setAmountData

billingAddress

getBillingAddress

setBillingAddress

captureDelayHours

getCaptureDelayHours

setCaptureDelayHours

channel

getChannel

setChannel

company

getCompany

setCompany

countryCode

getCountryCode

setCountryCode

dateOfBirth

getDateOfBirth

setDateOfBirth

dccQuote

getDccQuote

setDccQuote

deliveryAddress

getDeliveryAddress

setDeliveryAddress

deliveryDate

getDeliveryDate

setDeliveryDate

enableOneClick

isEnableOneClick

setEnableOneClick

enablePayOut

isEnablePayOut

setEnablePayOut

enableRecurring

isEnableRecurring

setEnableRecurring

entityType

getEntityType

setEntityType

fraudOffset

getFraudOffset

setFraudOffset

installments

getInstallments

setInstallments

lineItems

addLineItemsItem

getLineItems