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

public class SubmitRequest
extends Object

SubmitRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SubmitRequest.EntityTypeEnum
The type of the entity the payout is processed for.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ADDITIONAL_DATA`
`static String`	`JSON_PROPERTY_AMOUNT`
`static String`	`JSON_PROPERTY_DATE_OF_BIRTH`
`static String`	`JSON_PROPERTY_ENTITY_TYPE`
`static String`	`JSON_PROPERTY_FRAUD_OFFSET`
`static String`	`JSON_PROPERTY_MERCHANT_ACCOUNT`
`static String`	`JSON_PROPERTY_NATIONALITY`
`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_NAME`
`static String`	`JSON_PROPERTY_SHOPPER_REFERENCE`
`static String`	`JSON_PROPERTY_SHOPPER_STATEMENT`
`static String`	`JSON_PROPERTY_SOCIAL_SECURITY_NUMBER`

Constructor Summary

Constructors
Constructor Description

SubmitRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SubmitRequest`	`additionalData(Map<String,String> additionalData)`
`SubmitRequest`	`amount(Amount amount)`
`SubmitRequest`	`dateOfBirth(LocalDate dateOfBirth)`
`SubmitRequest`	`entityType(SubmitRequest.EntityTypeEnum entityType)`
`boolean`	`equals(Object o)`	Return true if this SubmitRequest object is equal to o.
`SubmitRequest`	`fraudOffset(Integer fraudOffset)`
`static SubmitRequest`	`fromJson(String jsonString)`	Create an instance of SubmitRequest given an JSON string
`Map<String,String>`	`getAdditionalData()`	This field contains additional data, which may be required for a particular request.
`Amount`	`getAmount()`	Get amount
`LocalDate`	`getDateOfBirth()`	The date of birth.
`SubmitRequest.EntityTypeEnum`	`getEntityType()`	The type of the entity the payout is processed for.
`Integer`	`getFraudOffset()`	An integer value that is added to the normal fraud score.
`String`	`getMerchantAccount()`	The merchant account identifier you want to process the transaction request with.
`String`	`getNationality()`	The shopper's nationality.
`Recurring`	`getRecurring()`	Get recurring
`String`	`getReference()`	The merchant reference for this payout.
`String`	`getSelectedRecurringDetailReference()`	This is the `recurringDetailReference` you want to use for this payout.
`String`	`getShopperEmail()`	The shopper's email address.
`Name`	`getShopperName()`	Get shopperName
`String`	`getShopperReference()`	The shopper's reference for the payout transaction.
`String`	`getShopperStatement()`	The description of this payout.
`String`	`getSocialSecurityNumber()`	The shopper's social security number.
`int`	`hashCode()`
`SubmitRequest`	`merchantAccount(String merchantAccount)`
`SubmitRequest`	`nationality(String nationality)`
`SubmitRequest`	`putAdditionalDataItem(String key, String additionalDataItem)`
`SubmitRequest`	`recurring(Recurring recurring)`
`SubmitRequest`	`reference(String reference)`
`SubmitRequest`	`selectedRecurringDetailReference(String selectedRecurringDetailReference)`
`void`	`setAdditionalData(Map<String,String> additionalData)`	This field contains additional data, which may be required for a particular request.
`void`	`setAmount(Amount amount)`	amount
`void`	`setDateOfBirth(LocalDate dateOfBirth)`	The date of birth.
`void`	`setEntityType(SubmitRequest.EntityTypeEnum entityType)`	The type of the entity the payout is processed for.
`void`	`setFraudOffset(Integer fraudOffset)`	An integer value that is added to the normal fraud score.
`void`	`setMerchantAccount(String merchantAccount)`	The merchant account identifier you want to process the transaction request with.
`void`	`setNationality(String nationality)`	The shopper's nationality.
`void`	`setRecurring(Recurring recurring)`	recurring
`void`	`setReference(String reference)`	The merchant reference for this payout.
`void`	`setSelectedRecurringDetailReference(String selectedRecurringDetailReference)`	This is the `recurringDetailReference` you want to use for this payout.
`void`	`setShopperEmail(String shopperEmail)`	The shopper's email address.
`void`	`setShopperName(Name shopperName)`	shopperName
`void`	`setShopperReference(String shopperReference)`	The shopper's reference for the payout transaction.
`void`	`setShopperStatement(String shopperStatement)`	The description of this payout.
`void`	`setSocialSecurityNumber(String socialSecurityNumber)`	The shopper's social security number.
`SubmitRequest`	`shopperEmail(String shopperEmail)`
`SubmitRequest`	`shopperName(Name shopperName)`
`SubmitRequest`	`shopperReference(String shopperReference)`
`SubmitRequest`	`shopperStatement(String shopperStatement)`
`SubmitRequest`	`socialSecurityNumber(String socialSecurityNumber)`
`String`	`toJson()`	Convert an instance of SubmitRequest 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_ADDITIONAL_DATA
```
public static final String JSON_PROPERTY_ADDITIONAL_DATA
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_AMOUNT
```
public static final String JSON_PROPERTY_AMOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DATE_OF_BIRTH
```
public static final String JSON_PROPERTY_DATE_OF_BIRTH
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ENTITY_TYPE
```
public static final String JSON_PROPERTY_ENTITY_TYPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FRAUD_OFFSET
```
public static final String JSON_PROPERTY_FRAUD_OFFSET
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MERCHANT_ACCOUNT
```
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_NATIONALITY
```
public static final String JSON_PROPERTY_NATIONALITY
```
    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_NAME
```
public static final String JSON_PROPERTY_SHOPPER_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_REFERENCE
```
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SHOPPER_STATEMENT
```
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SubmitRequest
```
public SubmitRequest()
```
- Method Detail
  - additionalData
```
public SubmitRequest additionalData(Map<String,String> additionalData)
```
  - putAdditionalDataItem
```
public SubmitRequest putAdditionalDataItem(String key,
                                           String additionalDataItem)
```
  - getAdditionalData
```
public Map<String,String> getAdditionalData()
```
    This field contains additional data, which may be required for a particular request.
    
    Returns:
    
    additionalData
  - setAdditionalData
```
public void setAdditionalData(Map<String,String> additionalData)
```
    This field contains additional data, which may be required for a particular request.
    
    Parameters:
    
    additionalData -
  - amount
```
public SubmitRequest amount(Amount amount)
```
  - getAmount
```
public Amount getAmount()
```
    Get amount
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(Amount amount)
```
    amount
    
    Parameters:
    
    amount -
  - dateOfBirth
```
public SubmitRequest dateOfBirth(LocalDate dateOfBirth)
```
  - getDateOfBirth
```
public LocalDate getDateOfBirth()
```
    The date of birth. Format: ISO-8601; example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account. > This field is mandatory for natural persons. > This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.
    
    Returns:
    
    dateOfBirth
  - setDateOfBirth
```
public void setDateOfBirth(LocalDate dateOfBirth)
```
    The date of birth. Format: ISO-8601; example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account. > This field is mandatory for natural persons. > This field is required to update the existing `dateOfBirth` that is associated with this recurring contract.
    
    Parameters:
    
    dateOfBirth -
  - entityType
```
public SubmitRequest entityType(SubmitRequest.EntityTypeEnum entityType)
```
  - getEntityType
```
public SubmitRequest.EntityTypeEnum getEntityType()
```
    The type of the entity the payout is processed for. Allowed values: * NaturalPerson * Company > This field is required to update the existing `entityType` that is associated with this recurring contract.
    
    Returns:
    
    entityType
  - setEntityType
```
public void setEntityType(SubmitRequest.EntityTypeEnum entityType)
```
    The type of the entity the payout is processed for. Allowed values: * NaturalPerson * Company > This field is required to update the existing `entityType` that is associated with this recurring contract.
    
    Parameters:
    
    entityType -
  - fraudOffset
```
public SubmitRequest 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 -
  - merchantAccount
```
public SubmitRequest merchantAccount(String merchantAccount)
```
  - getMerchantAccount
```
public String getMerchantAccount()
```
    The merchant account identifier you want to process the transaction request with.
    
    Returns:
    
    merchantAccount
  - setMerchantAccount
```
public void setMerchantAccount(String merchantAccount)
```
    The merchant account identifier you want to process the transaction request with.
    
    Parameters:
    
    merchantAccount -
  - nationality
```
public SubmitRequest nationality(String nationality)
```
  - getNationality
```
public String getNationality()
```
    The shopper's nationality. A valid value is an ISO 2-character country code (e.g. 'NL'). > This field is required to update the existing nationality that is associated with this recurring contract.
    
    Returns:
    
    nationality
  - setNationality
```
public void setNationality(String nationality)
```
    The shopper's nationality. A valid value is an ISO 2-character country code (e.g. 'NL'). > This field is required to update the existing nationality that is associated with this recurring contract.
    
    Parameters:
    
    nationality -
  - recurring
```
public SubmitRequest recurring(Recurring recurring)
```
  - getRecurring
```
public Recurring getRecurring()
```
    Get recurring
    
    Returns:
    
    recurring
  - setRecurring
```
public void setRecurring(Recurring recurring)
```
    recurring
    
    Parameters:
    
    recurring -
  - reference
```
public SubmitRequest reference(String reference)
```
  - getReference
```
public String getReference()
```
    The merchant reference for this payout. This reference will be used in all communication to the merchant about the status of the payout. Although it is a good idea to make sure it is unique, this is not a requirement.
    
    Returns:
    
    reference
  - setReference
```
public void setReference(String reference)
```
    The merchant reference for this payout. This reference will be used in all communication to the merchant about the status of the payout. Although it is a good idea to make sure it is unique, this is not a requirement.
    
    Parameters:
    
    reference -
  - selectedRecurringDetailReference
```
public SubmitRequest selectedRecurringDetailReference(String selectedRecurringDetailReference)
```
  - getSelectedRecurringDetailReference
```
public String getSelectedRecurringDetailReference()
```
    This is the `recurringDetailReference` you want to use for this payout. You can use the value LATEST to select the most recently used recurring detail.
    
    Returns:
    
    selectedRecurringDetailReference
  - setSelectedRecurringDetailReference
```
public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
```
    This is the `recurringDetailReference` you want to use for this payout. You can use the value LATEST to select the most recently used recurring detail.
    
    Parameters:
    
    selectedRecurringDetailReference -
  - shopperEmail
```
public SubmitRequest shopperEmail(String shopperEmail)
```
  - getShopperEmail
```
public String getShopperEmail()
```
    The shopper's email address.
    
    Returns:
    
    shopperEmail
  - setShopperEmail
```
public void setShopperEmail(String shopperEmail)
```
    The shopper's email address.
    
    Parameters:
    
    shopperEmail -
  - shopperName
```
public SubmitRequest shopperName(Name shopperName)
```
  - getShopperName
```
public Name getShopperName()
```
    Get shopperName
    
    Returns:
    
    shopperName
  - setShopperName
```
public void setShopperName(Name shopperName)
```
    shopperName
    
    Parameters:
    
    shopperName -
  - shopperReference
```
public SubmitRequest shopperReference(String shopperReference)
```
  - getShopperReference
```
public String getShopperReference()
```
    The shopper's reference for the payout transaction.
    
    Returns:
    
    shopperReference
  - setShopperReference
```
public void setShopperReference(String shopperReference)
```
    The shopper's reference for the payout transaction.
    
    Parameters:
    
    shopperReference -
  - shopperStatement
```
public SubmitRequest shopperStatement(String shopperStatement)
```
  - getShopperStatement
```
public String getShopperStatement()
```
    The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).
    
    Returns:
    
    shopperStatement
  - setShopperStatement
```
public void setShopperStatement(String shopperStatement)
```
    The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method).
    
    Parameters:
    
    shopperStatement -
  - socialSecurityNumber
```
public SubmitRequest socialSecurityNumber(String socialSecurityNumber)
```
  - getSocialSecurityNumber
```
public String getSocialSecurityNumber()
```
    The shopper's social security number.
    
    Returns:
    
    socialSecurityNumber
  - setSocialSecurityNumber
```
public void setSocialSecurityNumber(String socialSecurityNumber)
```
    The shopper's social security number.
    
    Parameters:
    
    socialSecurityNumber -
  - equals
```
public boolean equals(Object o)
```
    Return true if this SubmitRequest 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 SubmitRequest fromJson(String jsonString)
                              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of SubmitRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of SubmitRequest
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to SubmitRequest
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of SubmitRequest to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class SubmitRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ADDITIONAL_DATA

JSON_PROPERTY_AMOUNT

JSON_PROPERTY_DATE_OF_BIRTH

JSON_PROPERTY_ENTITY_TYPE

JSON_PROPERTY_FRAUD_OFFSET

JSON_PROPERTY_MERCHANT_ACCOUNT

JSON_PROPERTY_NATIONALITY

JSON_PROPERTY_RECURRING

JSON_PROPERTY_REFERENCE

JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE

JSON_PROPERTY_SHOPPER_EMAIL

JSON_PROPERTY_SHOPPER_NAME

JSON_PROPERTY_SHOPPER_REFERENCE

JSON_PROPERTY_SHOPPER_STATEMENT

JSON_PROPERTY_SOCIAL_SECURITY_NUMBER

Constructor Detail

SubmitRequest

Method Detail

additionalData

putAdditionalDataItem

getAdditionalData

setAdditionalData

amount

getAmount

setAmount

dateOfBirth

getDateOfBirth

setDateOfBirth

entityType

getEntityType

setEntityType

fraudOffset

getFraudOffset

setFraudOffset

merchantAccount

getMerchantAccount

setMerchantAccount

nationality

getNationality

setNationality

recurring

getRecurring

setRecurring

reference

getReference

setReference

selectedRecurringDetailReference

getSelectedRecurringDetailReference

setSelectedRecurringDetailReference

shopperEmail

getShopperEmail

setShopperEmail

shopperName

getShopperName

setShopperName

shopperReference

getShopperReference

setShopperReference

shopperStatement

getShopperStatement

setShopperStatement

socialSecurityNumber

getSocialSecurityNumber

setSocialSecurityNumber

equals

hashCode

toString

fromJson

toJson