Package com.adyen.model.payout

Class PayoutRequest

  • public class PayoutRequest
extends Object
    PayoutRequest

    • Constructor Detail

      • PayoutRequest

        public PayoutRequest()

    • Method Detail

      • amount

        public PayoutRequest amount​(Amount amount)
        amount
        Parameters:
        amount -
        Returns:
        the current PayoutRequest instance, allowing for method chaining

      • getAmount

        public Amount getAmount()
        amount
        Returns:
        amount

      • setAmount

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

      • billingAddress

        public PayoutRequest billingAddress​(Address billingAddress)
        billingAddress
        Parameters:
        billingAddress -
        Returns:
        the current PayoutRequest instance, allowing for method chaining

      • getBillingAddress

        public Address getBillingAddress()
        billingAddress
        Returns:
        billingAddress

      • setBillingAddress

        public void setBillingAddress​(Address billingAddress)
        billingAddress
        Parameters:
        billingAddress -

      • card

        public PayoutRequest card​(Card card)
        card
        Parameters:
        card -
        Returns:
        the current PayoutRequest instance, allowing for method chaining

      • getCard

        public Card getCard()
        card
        Returns:
        card

      • setCard

        public void setCard​(Card card)
        card
        Parameters:
        card -

      • fraudOffset

        public PayoutRequest 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 PayoutRequest 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 -

      • fundSource

        public PayoutRequest fundSource​(FundSource fundSource)
        fundSource
        Parameters:
        fundSource -
        Returns:
        the current PayoutRequest instance, allowing for method chaining

      • getFundSource

        public FundSource getFundSource()
        fundSource
        Returns:
        fundSource

      • setFundSource

        public void setFundSource​(FundSource fundSource)
        fundSource
        Parameters:
        fundSource -

      • merchantAccount

        public PayoutRequest merchantAccount​(String merchantAccount)
        The merchant account identifier, with which you want to process the transaction.
        Parameters:
        merchantAccount -
        Returns:
        the current PayoutRequest instance, allowing for method chaining

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

      • getRecurring

        public Recurring getRecurring()
        recurring
        Returns:
        recurring

      • setRecurring

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

      • reference

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

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

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

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

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

      • getShopperName

        public Name getShopperName()
        shopperName
        Returns:
        shopperName

      • setShopperName

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

      • shopperReference

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

      • 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)
        The shopper's telephone number.
        Parameters:
        telephoneNumber -
        Returns:
        the current PayoutRequest instance, allowing for method chaining

      • 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

      • 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