PayoutRequest (Adyen Java API Library 17.3.0 API)

java.lang.Object
- com.adyen.model.payout.PayoutRequest

public class PayoutRequest
extends Object

PayoutRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PayoutRequest.EntityTypeEnum` The type of the entity the payment is processed for.
`static class`	`PayoutRequest.RecurringProcessingModelEnum` Defines a recurring payment type.
`static class`	`PayoutRequest.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

PayoutRequest()

Constructors
Constructor and Description
`PayoutRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PayoutRequest`	`accountInfo(AccountInfo accountInfo)`
`PayoutRequest`	`additionalAmount(Amount additionalAmount)`
`PayoutRequest`	`additionalData(Map<String,String> additionalData)`
`PayoutRequest`	`addSplitsItem(Split splitsItem)`
`PayoutRequest`	`amount(Amount amount)`
`PayoutRequest`	`applicationInfo(ApplicationInfo applicationInfo)`
`PayoutRequest`	`bankAccount(BankAccount bankAccount)`
`PayoutRequest`	`billingAddress(Address billingAddress)`
`PayoutRequest`	`browserInfo(BrowserInfo browserInfo)`
`PayoutRequest`	`captureDelayHours(Integer captureDelayHours)`
`PayoutRequest`	`card(Card card)`
`PayoutRequest`	`dateOfBirth(Date dateOfBirth)`
`PayoutRequest`	`dccQuote(ForexQuote dccQuote)`
`PayoutRequest`	`deliveryAddress(Address deliveryAddress)`
`PayoutRequest`	`deliveryDate(Date deliveryDate)`
`PayoutRequest`	`deviceFingerprint(String deviceFingerprint)`
`PayoutRequest`	`enableRealTimeUpdate(Boolean enableRealTimeUpdate)`
`PayoutRequest`	`entityType(PayoutRequest.EntityTypeEnum entityType)`
`boolean`	`equals(Object o)`
`PayoutRequest`	`fraudOffset(Integer fraudOffset)`
`PayoutRequest`	`fundSource(FundSource fundSource)`
`AccountInfo`	`getAccountInfo()` Get accountInfo
`Amount`	`getAdditionalAmount()` Get additionalAmount
`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
`BankAccount`	`getBankAccount()` Get bankAccount
`Address`	`getBillingAddress()` Get billingAddress
`BrowserInfo`	`getBrowserInfo()` Get browserInfo
`Integer`	`getCaptureDelayHours()` The delay between the authorisation and scheduled auto-capture, specified in hours.
`Card`	`getCard()` Get card
`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.
`PayoutRequest.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.
`FundSource`	`getFundSource()` Get fundSource
`Installments`	`getInstallments()` Get installments
`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()` Get merchantRiskIndicator
`Map<String,String>`	`getMetadata()` Metadata consists of entries, each of which includes a key and a value.
`ThreeDSecureData`	`getMpiData()` Get mpiData
`String`	`getNationality()` The two-character country code of the shopper's nationality.
`String`	`getOrderReference()` The order reference to link multiple partial payments.
`Recurring`	`getRecurring()` Get recurring
`PayoutRequest.RecurringProcessingModelEnum`	`getRecurringProcessingModel()` Defines a recurring payment type.
`String`	`getReference()` The reference to uniquely identify a payment.
`String`	`getSelectedBrand()` Some payment methods require defining a value for this field to specify how to process the transaction.
`String`	`getSelectedRecurringDetailReference()` The `recurringDetailReference` you want to use for this payment.
`String`	`getSessionId()` A session ID used to identify a payment session.
`String`	`getShopperEmail()` The shopper's email address.
`PayoutRequest.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()` The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
`String`	`getStore()` The physical store, for which this payment is processed.
`String`	`getTelephoneNumber()` The shopper's telephone number.
`ThreeDS2RequestData`	`getThreeDS2RequestData()` Get threeDS2RequestData
`String`	`getTotalsGroup()` The reference value to aggregate sales totals in reporting.
`int`	`hashCode()`
`PayoutRequest`	`installments(Installments installments)`
`Boolean`	`isEnableRealTimeUpdate()` Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.
`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.
`Boolean`	`isTrustedShopper()` Set to true if the payment should be routed to a trusted MID.
`PayoutRequest`	`mcc(String mcc)`
`PayoutRequest`	`merchantAccount(String merchantAccount)`
`PayoutRequest`	`merchantOrderReference(String merchantOrderReference)`
`PayoutRequest`	`merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)`
`PayoutRequest`	`metadata(Map<String,String> metadata)`
`PayoutRequest`	`mpiData(ThreeDSecureData mpiData)`
`PayoutRequest`	`nationality(String nationality)`
`PayoutRequest`	`orderReference(String orderReference)`
`PayoutRequest`	`recurring(Recurring recurring)`
`PayoutRequest`	`recurringProcessingModel(PayoutRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`PayoutRequest`	`reference(String reference)`
`PayoutRequest`	`selectedBrand(String selectedBrand)`
`PayoutRequest`	`selectedRecurringDetailReference(String selectedRecurringDetailReference)`
`PayoutRequest`	`sessionId(String sessionId)`
`void`	`setAccountInfo(AccountInfo accountInfo)`
`void`	`setAdditionalAmount(Amount additionalAmount)`
`void`	`setAdditionalData(Map<String,String> additionalData)`
`void`	`setAmount(Amount amount)`
`void`	`setApplicationInfo(ApplicationInfo applicationInfo)`
`void`	`setBankAccount(BankAccount bankAccount)`
`void`	`setBillingAddress(Address billingAddress)`
`void`	`setBrowserInfo(BrowserInfo browserInfo)`
`void`	`setCaptureDelayHours(Integer captureDelayHours)`
`void`	`setCard(Card card)`
`void`	`setDateOfBirth(Date dateOfBirth)`
`void`	`setDccQuote(ForexQuote dccQuote)`
`void`	`setDeliveryAddress(Address deliveryAddress)`
`void`	`setDeliveryDate(Date deliveryDate)`
`void`	`setDeviceFingerprint(String deviceFingerprint)`
`void`	`setEnableRealTimeUpdate(Boolean enableRealTimeUpdate)`
`void`	`setEntityType(PayoutRequest.EntityTypeEnum entityType)`
`void`	`setFraudOffset(Integer fraudOffset)`
`void`	`setFundSource(FundSource fundSource)`
`void`	`setInstallments(Installments installments)`
`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`	`setNationality(String nationality)`
`void`	`setOrderReference(String orderReference)`
`void`	`setRecurring(Recurring recurring)`
`void`	`setRecurringProcessingModel(PayoutRequest.RecurringProcessingModelEnum recurringProcessingModel)`
`void`	`setReference(String reference)`
`void`	`setSelectedBrand(String selectedBrand)`
`void`	`setSelectedRecurringDetailReference(String selectedRecurringDetailReference)`
`void`	`setSessionId(String sessionId)`
`void`	`setShopperEmail(String shopperEmail)`
`void`	`setShopperInteraction(PayoutRequest.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`	`setTelephoneNumber(String telephoneNumber)`
`void`	`setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)`
`void`	`setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`
`void`	`setTotalsGroup(String totalsGroup)`
`void`	`setTrustedShopper(Boolean trustedShopper)`
`PayoutRequest`	`shopperEmail(String shopperEmail)`
`PayoutRequest`	`shopperInteraction(PayoutRequest.ShopperInteractionEnum shopperInteraction)`
`PayoutRequest`	`shopperIP(String shopperIP)`
`PayoutRequest`	`shopperLocale(String shopperLocale)`
`PayoutRequest`	`shopperName(Name shopperName)`
`PayoutRequest`	`shopperReference(String shopperReference)`
`PayoutRequest`	`shopperStatement(String shopperStatement)`
`PayoutRequest`	`socialSecurityNumber(String socialSecurityNumber)`
`PayoutRequest`	`splits(List<Split> splits)`
`PayoutRequest`	`store(String store)`
`PayoutRequest`	`telephoneNumber(String telephoneNumber)`
`PayoutRequest`	`threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)`
`PayoutRequest`	`threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)`
`String`	`toString()`
`PayoutRequest`	`totalsGroup(String totalsGroup)`
`PayoutRequest`	`trustedShopper(Boolean trustedShopper)`

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

- Constructor Detail
  - PayoutRequest
```
public PayoutRequest()
```
- Method Detail
  - accountInfo
```
public PayoutRequest accountInfo(AccountInfo accountInfo)
```
  - getAccountInfo
```
public AccountInfo getAccountInfo()
```
    Get accountInfo
    
    Returns:
    
    accountInfo
  - setAccountInfo
```
public void setAccountInfo(AccountInfo accountInfo)
```
  - additionalAmount
```
public PayoutRequest additionalAmount(Amount additionalAmount)
```
  - getAdditionalAmount
```
public Amount getAdditionalAmount()
```
    Get additionalAmount
    
    Returns:
    
    additionalAmount
  - setAdditionalAmount
```
public void setAdditionalAmount(Amount additionalAmount)
```
  - additionalData
```
public PayoutRequest additionalData(Map<String,String> additionalData)
```
  - 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/api-reference/payments-api#paymentrequestadditionaldata).
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
  - amount
```
public PayoutRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
  - applicationInfo
```
public PayoutRequest applicationInfo(ApplicationInfo applicationInfo)
```
  - getApplicationInfo
```
public ApplicationInfo getApplicationInfo()
```
    Get applicationInfo
    
    Returns:
    
    applicationInfo
  - setApplicationInfo
```
public void setApplicationInfo(ApplicationInfo applicationInfo)
```
  - bankAccount
```
public PayoutRequest bankAccount(BankAccount bankAccount)
```
  - getBankAccount
```
public BankAccount getBankAccount()
```
    Get bankAccount
    
    Returns:
    
    bankAccount
  - setBankAccount
```
public void setBankAccount(BankAccount bankAccount)
```
  - billingAddress
```
public PayoutRequest billingAddress(Address billingAddress)
```
  - getBillingAddress
```
public Address getBillingAddress()
```
    Get billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
  - browserInfo
```
public PayoutRequest browserInfo(BrowserInfo browserInfo)
```
  - getBrowserInfo
```
public BrowserInfo getBrowserInfo()
```
    Get browserInfo
    
    Returns:
    
    browserInfo
  - setBrowserInfo
```
public void setBrowserInfo(BrowserInfo browserInfo)
```
  - captureDelayHours
```
public PayoutRequest 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)
```
  - card
```
public PayoutRequest card(Card card)
```
  - getCard
```
public Card getCard()
```
    Get card
    
    Returns:
    
    card
  - setCard
```
public void setCard(Card card)
```
  - dateOfBirth
```
public PayoutRequest 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 PayoutRequest dccQuote(ForexQuote dccQuote)
```
  - getDccQuote
```
public ForexQuote getDccQuote()
```
    Get dccQuote
    
    Returns:
    
    dccQuote
  - setDccQuote
```
public void setDccQuote(ForexQuote dccQuote)
```
  - deliveryAddress
```
public PayoutRequest deliveryAddress(Address deliveryAddress)
```
  - getDeliveryAddress
```
public Address getDeliveryAddress()
```
    Get deliveryAddress
    
    Returns:
    
    deliveryAddress
  - setDeliveryAddress
```
public void setDeliveryAddress(Address deliveryAddress)
```
  - deliveryDate
```
public PayoutRequest 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 PayoutRequest 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)
```
  - enableRealTimeUpdate
```
public PayoutRequest enableRealTimeUpdate(Boolean enableRealTimeUpdate)
```
  - isEnableRealTimeUpdate
```
public Boolean isEnableRealTimeUpdate()
```
    Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.
    
    Returns:
    
    enableRealTimeUpdate
  - setEnableRealTimeUpdate
```
public void setEnableRealTimeUpdate(Boolean enableRealTimeUpdate)
```
  - entityType
```
public PayoutRequest entityType(PayoutRequest.EntityTypeEnum entityType)
```
  - getEntityType
```
public PayoutRequest.EntityTypeEnum getEntityType()
```
    The type of the entity the payment is processed for.
    
    Returns:
    
    entityType
  - setEntityType
```
public void setEntityType(PayoutRequest.EntityTypeEnum entityType)
```
  - fraudOffset
```
public PayoutRequest 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)
```
  - fundSource
```
public PayoutRequest fundSource(FundSource fundSource)
```
  - getFundSource
```
public FundSource getFundSource()
```
    Get fundSource
    
    Returns:
    
    fundSource
  - setFundSource
```
public void setFundSource(FundSource fundSource)
```
  - installments
```
public PayoutRequest installments(Installments installments)
```
  - getInstallments
```
public Installments getInstallments()
```
    Get installments
    
    Returns:
    
    installments
  - setInstallments
```
public void setInstallments(Installments installments)
```
  - mcc
```
public PayoutRequest 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 PayoutRequest 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 PayoutRequest merchantOrderReference(String merchantOrderReference)
```
  - getMerchantOrderReference
```
public String getMerchantOrderReference()
```
    This reference allows linking multiple transactions to each other. > 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)
```
  - merchantRiskIndicator
```
public PayoutRequest merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
  - getMerchantRiskIndicator
```
public MerchantRiskIndicator getMerchantRiskIndicator()
```
    Get merchantRiskIndicator
    
    Returns:
    
    merchantRiskIndicator
  - setMerchantRiskIndicator
```
public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
```
  - metadata
```
public PayoutRequest metadata(Map<String,String> metadata)
```
  - 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)
```
  - mpiData
```
public PayoutRequest mpiData(ThreeDSecureData mpiData)
```
  - getMpiData
```
public ThreeDSecureData getMpiData()
```
    Get mpiData
    
    Returns:
    
    mpiData
  - setMpiData
```
public void setMpiData(ThreeDSecureData mpiData)
```
  - nationality
```
public PayoutRequest nationality(String nationality)
```
  - getNationality
```
public String getNationality()
```
    The two-character country code of the shopper's nationality.
    
    Returns:
    
    nationality
  - setNationality
```
public void setNationality(String nationality)
```
  - orderReference
```
public PayoutRequest orderReference(String orderReference)
```
  - getOrderReference
```
public String getOrderReference()
```
    The order reference to link multiple partial payments.
    
    Returns:
    
    orderReference
  - setOrderReference
```
public void setOrderReference(String orderReference)
```
  - recurring
```
public PayoutRequest recurring(Recurring recurring)
```
  - getRecurring
```
public Recurring getRecurring()
```
    Get recurring
    
    Returns:
    
    recurring
  - setRecurring
```
public void setRecurring(Recurring recurring)
```
  - recurringProcessingModel
```
public PayoutRequest recurringProcessingModel(PayoutRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - getRecurringProcessingModel
```
public PayoutRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
```
    Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – 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.
    
    Returns:
    
    recurringProcessingModel
  - setRecurringProcessingModel
```
public void setRecurringProcessingModel(PayoutRequest.RecurringProcessingModelEnum recurringProcessingModel)
```
  - reference
```
public PayoutRequest 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)
```
  - selectedBrand
```
public PayoutRequest selectedBrand(String selectedBrand)
```
  - getSelectedBrand
```
public String getSelectedBrand()
```
    Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card.
    
    Returns:
    
    selectedBrand
  - setSelectedBrand
```
public void setSelectedBrand(String selectedBrand)
```
  - selectedRecurringDetailReference
```
public PayoutRequest selectedRecurringDetailReference(String selectedRecurringDetailReference)
```
  - getSelectedRecurringDetailReference
```
public String getSelectedRecurringDetailReference()
```
    The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
    
    Returns:
    
    selectedRecurringDetailReference
  - setSelectedRecurringDetailReference
```
public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
```
  - sessionId
```
public PayoutRequest sessionId(String sessionId)
```
  - getSessionId
```
public String getSessionId()
```
    A session ID used to identify a payment session.
    
    Returns:
    
    sessionId
  - setSessionId
```
public void setSessionId(String sessionId)
```
  - shopperEmail
```
public PayoutRequest 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 PayoutRequest 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 PayoutRequest shopperInteraction(PayoutRequest.ShopperInteractionEnum shopperInteraction)
```
  - getShopperInteraction
```
public PayoutRequest.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(PayoutRequest.ShopperInteractionEnum shopperInteraction)
```
  - shopperLocale
```
public PayoutRequest 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 PayoutRequest shopperName(Name shopperName)
```
  - getShopperName
```
public Name getShopperName()
```
    Get shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
  - shopperReference
```
public PayoutRequest 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 PayoutRequest 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 PayoutRequest socialSecurityNumber(String socialSecurityNumber)
```
  - getSocialSecurityNumber
```
public String getSocialSecurityNumber()
```
    The shopper's social security number.
    
    Returns:
    
    socialSecurityNumber
  - setSocialSecurityNumber
```
public void setSocialSecurityNumber(String socialSecurityNumber)
```
  - splits
```
public PayoutRequest splits(List<Split> splits)
```
  - addSplitsItem
```
public PayoutRequest addSplitsItem(Split splitsItem)
```
  - getSplits
```
public List<Split> getSplits()
```
    The details of how the payment should be split when distributing a payment to a MarketPay Marketplace and its Accounts.
    
    Returns:
    
    splits
  - setSplits
```
public void setSplits(List<Split> splits)
```
  - store
```
public PayoutRequest store(String store)
```
  - getStore
```
public String getStore()
```
    The physical store, for which this payment is processed.
    
    Returns:
    
    store
  - setStore
```
public void setStore(String store)
```
  - telephoneNumber
```
public PayoutRequest telephoneNumber(String telephoneNumber)
```
  - getTelephoneNumber
```
public String getTelephoneNumber()
```
    The shopper's telephone number.
    
    Returns:
    
    telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(String telephoneNumber)
```
  - threeDS2RequestData
```
public PayoutRequest threeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
```
  - getThreeDS2RequestData
```
public ThreeDS2RequestData getThreeDS2RequestData()
```
    Get threeDS2RequestData
    
    Returns:
    
    threeDS2RequestData
  - setThreeDS2RequestData
```
public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData)
```
  - threeDSAuthenticationOnly
```
public PayoutRequest 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)
```
  - totalsGroup
```
public PayoutRequest totalsGroup(String totalsGroup)
```
  - getTotalsGroup
```
public String getTotalsGroup()
```
    The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
    
    Returns:
    
    totalsGroup
  - setTotalsGroup
```
public void setTotalsGroup(String totalsGroup)
```
  - trustedShopper
```
public PayoutRequest 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 PayoutRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PayoutRequest

Method Detail

accountInfo

getAccountInfo

setAccountInfo

additionalAmount

getAdditionalAmount

setAdditionalAmount

additionalData

getAdditionalData

setAdditionalData

amount

getAmount

setAmount

applicationInfo

getApplicationInfo

setApplicationInfo

bankAccount

getBankAccount

setBankAccount

billingAddress

getBillingAddress

setBillingAddress

browserInfo

getBrowserInfo

setBrowserInfo

captureDelayHours

getCaptureDelayHours

setCaptureDelayHours

card

getCard

setCard

dateOfBirth

getDateOfBirth

setDateOfBirth

dccQuote

getDccQuote

setDccQuote

deliveryAddress

getDeliveryAddress

setDeliveryAddress

deliveryDate

getDeliveryDate

setDeliveryDate

deviceFingerprint

getDeviceFingerprint

setDeviceFingerprint

enableRealTimeUpdate

isEnableRealTimeUpdate

setEnableRealTimeUpdate

entityType

getEntityType

setEntityType

fraudOffset

getFraudOffset

setFraudOffset

fundSource

getFundSource

setFundSource

installments

getInstallments

setInstallments

mcc

getMcc

setMcc

merchantAccount

getMerchantAccount

setMerchantAccount

merchantOrderReference

getMerchantOrderReference

setMerchantOrderReference

merchantRiskIndicator

getMerchantRiskIndicator

setMerchantRiskIndicator