Package com.adyen.model.payout

Class SubmitRequest

  • public class SubmitRequest
extends Object
    SubmitRequest

    • Constructor Detail

      • SubmitRequest

        public SubmitRequest()

    • Method Detail

      • additionalData

        public SubmitRequest additionalData​(Map<String,​String> additionalData)
        This field contains additional data, which may be required for a particular request.
        Parameters:
        additionalData -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        amount
        Parameters:
        amount -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • getAmount

        public Amount getAmount()
        amount
        Returns:
        amount

      • setAmount

        public void setAmount​(Amount amount)
        amount
        Parameters:
        amount -

      • dateOfBirth

        public SubmitRequest dateOfBirth​(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 -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        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 -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        An integer value that is added to the normal fraud score. The value can be either positive or negative.
        Parameters:
        fraudOffset -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        The merchant account identifier you want to process the transaction request with.
        Parameters:
        merchantAccount -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        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 -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        recurring
        Parameters:
        recurring -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • getRecurring

        public Recurring getRecurring()
        recurring
        Returns:
        recurring

      • setRecurring

        public void setRecurring​(Recurring recurring)
        recurring
        Parameters:
        recurring -

      • reference

        public SubmitRequest reference​(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 -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        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 -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        The shopper's email address.
        Parameters:
        shopperEmail -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        shopperName
        Parameters:
        shopperName -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • getShopperName

        public Name getShopperName()
        shopperName
        Returns:
        shopperName

      • setShopperName

        public void setShopperName​(Name shopperName)
        shopperName
        Parameters:
        shopperName -

      • shopperReference

        public SubmitRequest shopperReference​(String shopperReference)
        The shopper's reference for the payout transaction.
        Parameters:
        shopperReference -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        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 -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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)
        The shopper's social security number.
        Parameters:
        socialSecurityNumber -
        Returns:
        the current SubmitRequest instance, allowing for method chaining

      • 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

      • 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