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

public class PayoutRequest
extends Object

PayoutRequest

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PayoutRequest.ShopperInteractionEnum`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_BILLING_ADDRESS`
`static String`	`JSON_PROPERTY_CARD`
`static String`	`JSON_PROPERTY_FRAUD_OFFSET`
`static String`	`JSON_PROPERTY_FUND_SOURCE`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_RECURRING`
`static String`	`JSON_PROPERTY_REFERENCE`
`static String`	`JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE`
`static String`	`JSON_PROPERTY_SHOPPER_EMAIL`
`static String`	`JSON_PROPERTY_SHOPPER_INTERACTION`
`static String`	`JSON_PROPERTY_SHOPPER_NAME`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_TELEPHONE_NUMBER`

Constructor Summary

Constructors
Constructor Description

PayoutRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PayoutRequest`	`amount(Amount amount)`
`PayoutRequest`	`billingAddress(Address billingAddress)`
`PayoutRequest`	`card(Card card)`
`boolean`	`equals(Object o)`	Return true if this PayoutRequest object is equal to o.
`PayoutRequest`	`fraudOffset(Integer fraudOffset)`
`static PayoutRequest`	`fromJson(String jsonString)`	Create an instance of PayoutRequest given an JSON string
`PayoutRequest`	`fundSource(FundSource fundSource)`
`Amount`	`getAmount()`	Get amount
`Address`	`getBillingAddress()`	Get billingAddress
`Card`	`getCard()`	Get card
`Integer`	`getFraudOffset()`	An integer value that is added to the normal fraud score.
`FundSource`	`getFundSource()`	Get fundSource
`String`	`getMerchantAccount()`	The merchant account identifier, with which you want to process the transaction.
`Recurring`	`getRecurring()`	Get recurring
`String`	`getReference()`	The reference to uniquely identify a payment.
`String`	`getSelectedRecurringDetailReference()`	The `recurringDetailReference` you want to use for this payment.
`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.
`Name`	`getShopperName()`	Get shopperName
`String`	`getShopperReference()`	Required for recurring payments.
`String`	`getTelephoneNumber()`	The shopper's telephone number.
`int`	`hashCode()`
`PayoutRequest`	`merchantAccount(String merchantAccount)`
`PayoutRequest`	`recurring(Recurring recurring)`
`PayoutRequest`	`reference(String reference)`
`PayoutRequest`	`selectedRecurringDetailReference(String selectedRecurringDetailReference)`
`void`	`setAmount(Amount amount)`	amount
`void`	`setBillingAddress(Address billingAddress)`	billingAddress
`void`	`setCard(Card card)`	card
`void`	`setFraudOffset(Integer fraudOffset)`	An integer value that is added to the normal fraud score.
`void`	`setFundSource(FundSource fundSource)`	fundSource
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account identifier, with which you want to process the transaction.
`void`	`setRecurring(Recurring recurring)`	recurring
`void`	`setReference(String reference)`	The reference to uniquely identify a payment.
`void`	`setSelectedRecurringDetailReference(String selectedRecurringDetailReference)`	The `recurringDetailReference` you want to use for this payment.
`void`	`setShopperEmail(String shopperEmail)`	The shopper's email address.
`void`	`setShopperInteraction(PayoutRequest.ShopperInteractionEnum shopperInteraction)`	Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
`void`	`setShopperName(Name shopperName)`	shopperName
`void`	`setShopperReference(String shopperReference)`	Required for recurring payments.
`void`	`setTelephoneNumber(String telephoneNumber)`	The shopper's telephone number.
`PayoutRequest`	`shopperEmail(String shopperEmail)`
`PayoutRequest`	`shopperInteraction(PayoutRequest.ShopperInteractionEnum shopperInteraction)`
`PayoutRequest`	`shopperName(Name shopperName)`
`PayoutRequest`	`shopperReference(String shopperReference)`
`PayoutRequest`	`telephoneNumber(String telephoneNumber)`
`String`	`toJson()`	Convert an instance of PayoutRequest to an JSON string
`String`	`toString()`

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

- Field Detail
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_BILLING_ADDRESS
```
public static final String JSON_PROPERTY_BILLING_ADDRESS
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_CARD
```
public static final String JSON_PROPERTY_CARD
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FRAUD_OFFSET
```
public static final String JSON_PROPERTY_FRAUD_OFFSET
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FUND_SOURCE
```
public static final String JSON_PROPERTY_FUND_SOURCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_RECURRING
```
public static final String JSON_PROPERTY_RECURRING
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_REFERENCE
```
public static final String JSON_PROPERTY_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
```
public static final String JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_EMAIL
```
public static final String JSON_PROPERTY_SHOPPER_EMAIL
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_INTERACTION
```
public static final String JSON_PROPERTY_SHOPPER_INTERACTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_NAME
```
public static final String JSON_PROPERTY_SHOPPER_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TELEPHONE_NUMBER
```
public static final String JSON_PROPERTY_TELEPHONE_NUMBER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PayoutRequest
```
public PayoutRequest()
```
- Method Detail
  - amount
```
public PayoutRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - billingAddress
```
public PayoutRequest billingAddress(Address billingAddress)
```
  - getBillingAddress
```
public Address getBillingAddress()
```
    Get billingAddress
    
    Returns:
    
    billingAddress
  - setBillingAddress
```
public void setBillingAddress(Address billingAddress)
```
    billingAddress
    
    Parameters:
    
    billingAddress -
  - card
```
public PayoutRequest card(Card card)
```
  - getCard
```
public Card getCard()
```
    Get card
    
    Returns:
    
    card
  - setCard
```
public void setCard(Card card)
```
    card
    
    Parameters:
    
    card -
  - 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)
```
    An integer value that is added to the normal fraud score. The value can be either positive or negative.
    
    Parameters:
    
    fraudOffset -
  - fundSource
```
public PayoutRequest fundSource(FundSource fundSource)
```
  - getFundSource
```
public FundSource getFundSource()
```
    Get fundSource
    
    Returns:
    
    fundSource
  - setFundSource
```
public void setFundSource(FundSource fundSource)
```
    fundSource
    
    Parameters:
    
    fundSource -
  - 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)
```
    The merchant account identifier, with which you want to process the transaction.
    
    Parameters:
    
    merchantAccount -
  - recurring
```
public PayoutRequest recurring(Recurring recurring)
```
  - getRecurring
```
public Recurring getRecurring()
```
    Get recurring
    
    Returns:
    
    recurring
  - setRecurring
```
public void setRecurring(Recurring recurring)
```
    recurring
    
    Parameters:
    
    recurring -
  - 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)
```
    The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters.
    
    Parameters:
    
    reference -
  - 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)
```
    The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
    
    Parameters:
    
    selectedRecurringDetailReference -
  - 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. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.
    
    Returns:
    
    shopperEmail
  - setShopperEmail
```
public void setShopperEmail(String shopperEmail)
```
    The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.
    
    Parameters:
    
    shopperEmail -
  - 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)
```
    Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.
    
    Parameters:
    
    shopperInteraction -
  - shopperName
```
public PayoutRequest shopperName(Name shopperName)
```
  - getShopperName
```
public Name getShopperName()
```
    Get shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
  - shopperReference
```
public PayoutRequest 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)
```
    Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
    
    Parameters:
    
    shopperReference -
  - telephoneNumber
```
public PayoutRequest telephoneNumber(String telephoneNumber)
```
  - getTelephoneNumber
```
public String getTelephoneNumber()
```
    The shopper's telephone number.
    
    Returns:
    
    telephoneNumber
  - setTelephoneNumber
```
public void setTelephoneNumber(String telephoneNumber)
```
    The shopper's telephone number.
    
    Parameters:
    
    telephoneNumber -
  - equals
```
public boolean equals(Object o)
```
    Return true if this PayoutRequest object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromJson
```
public static PayoutRequest fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of PayoutRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of PayoutRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to PayoutRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of PayoutRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class PayoutRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_BILLING_ADDRESS

JSON_PROPERTY_CARD

JSON_PROPERTY_FRAUD_OFFSET

JSON_PROPERTY_FUND_SOURCE

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_RECURRING

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE

JSON_PROPERTY_SHOPPER_EMAIL

JSON_PROPERTY_SHOPPER_INTERACTION

JSON_PROPERTY_SHOPPER_NAME

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_TELEPHONE_NUMBER

Constructor Detail

PayoutRequest

Method Detail

amount

getAmount

setAmount

billingAddress

getBillingAddress

setBillingAddress

card

getCard

setCard

fraudOffset

getFraudOffset

setFraudOffset

fundSource

getFundSource

setFundSource

merchantAccount

getMerchantAccount

setMerchantAccount

recurring

getRecurring

setRecurring

reference

getReference

setReference

selectedRecurringDetailReference

getSelectedRecurringDetailReference

setSelectedRecurringDetailReference

shopperEmail

getShopperEmail

setShopperEmail

shopperInteraction

getShopperInteraction

setShopperInteraction

shopperName

getShopperName

setShopperName

shopperReference

getShopperReference

setShopperReference

telephoneNumber

getTelephoneNumber

setTelephoneNumber

equals

hashCode

toString

fromJson

toJson