Package com.adyen.model.balanceplatform

Class TransferRouteRequest

  • public class TransferRouteRequest
extends Object
    TransferRouteRequest

    • Constructor Detail

      • TransferRouteRequest

        public TransferRouteRequest()

    • Method Detail

      • balanceAccountId

        public TransferRouteRequest balanceAccountId​(String balanceAccountId)
        The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). Required if `counterparty` is **transferInstrumentId**.
        Parameters:
        balanceAccountId -
        Returns:
        the current TransferRouteRequest instance, allowing for method chaining

      • getBalanceAccountId

        public String getBalanceAccountId()
        The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). Required if `counterparty` is **transferInstrumentId**.
        Returns:
        balanceAccountId

      • setBalanceAccountId

        public void setBalanceAccountId​(String balanceAccountId)
        The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). Required if `counterparty` is **transferInstrumentId**.
        Parameters:
        balanceAccountId -

      • balancePlatform

        public TransferRouteRequest balancePlatform​(String balancePlatform)
        The unique identifier assigned to the balance platform associated with the account holder.
        Parameters:
        balancePlatform -
        Returns:
        the current TransferRouteRequest instance, allowing for method chaining

      • getBalancePlatform

        public String getBalancePlatform()
        The unique identifier assigned to the balance platform associated with the account holder.
        Returns:
        balancePlatform

      • setBalancePlatform

        public void setBalancePlatform​(String balancePlatform)
        The unique identifier assigned to the balance platform associated with the account holder.
        Parameters:
        balancePlatform -

      • category

        public TransferRouteRequest category​(TransferRouteRequest.CategoryEnum category)
        The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.
        Parameters:
        category -
        Returns:
        the current TransferRouteRequest instance, allowing for method chaining

      • getCategory

        public TransferRouteRequest.CategoryEnum getCategory()
        The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.
        Returns:
        category

      • setCategory

        public void setCategory​(TransferRouteRequest.CategoryEnum category)
        The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account.
        Parameters:
        category -

      • counterparty

        public TransferRouteRequest counterparty​(Counterparty counterparty)
        counterparty
        Parameters:
        counterparty -
        Returns:
        the current TransferRouteRequest instance, allowing for method chaining

      • getCounterparty

        public Counterparty getCounterparty()
        counterparty
        Returns:
        counterparty

      • setCounterparty

        public void setCounterparty​(Counterparty counterparty)
        counterparty
        Parameters:
        counterparty -

      • country

        public TransferRouteRequest country​(String country)
        The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. > Either `counterparty` or `country` field must be provided in a transfer route request.
        Parameters:
        country -
        Returns:
        the current TransferRouteRequest instance, allowing for method chaining

      • getCountry

        public String getCountry()
        The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. > Either `counterparty` or `country` field must be provided in a transfer route request.
        Returns:
        country

      • setCountry

        public void setCountry​(String country)
        The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. > Either `counterparty` or `country` field must be provided in a transfer route request.
        Parameters:
        country -

      • currency

        public TransferRouteRequest currency​(String currency)
        The three-character ISO currency code of transfer. For example, **USD** or **EUR**.
        Parameters:
        currency -
        Returns:
        the current TransferRouteRequest instance, allowing for method chaining

      • getCurrency

        public String getCurrency()
        The three-character ISO currency code of transfer. For example, **USD** or **EUR**.
        Returns:
        currency

      • setCurrency

        public void setCurrency​(String currency)
        The three-character ISO currency code of transfer. For example, **USD** or **EUR**.
        Parameters:
        currency -

      • priorities

        public TransferRouteRequest priorities​(List<TransferRouteRequest.PrioritiesEnum> priorities)
        The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).
        Parameters:
        priorities -
        Returns:
        the current TransferRouteRequest instance, allowing for method chaining

      • getPriorities

        public List<TransferRouteRequest.PrioritiesEnum> getPriorities()
        The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).
        Returns:
        priorities

      • setPriorities

        public void setPriorities​(List<TransferRouteRequest.PrioritiesEnum> priorities)
        The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. Possible values: * **regular**: for normal, low-value transactions. * **fast**: a faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions. * **wire**: the fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: for instant funds transfers in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: for high-value transfers to a recipient in a different country. * **internal**: for transfers to an Adyen-issued business bank account (by bank account number/IBAN).
        Parameters:
        priorities -

      • equals

        public boolean equals​(Object o)
        Return true if this TransferRouteRequest object is equal to o.
        Overrides:
        equals in class Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

        public static TransferRouteRequest fromJson​(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of TransferRouteRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of TransferRouteRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to TransferRouteRequest

      • toJson

        public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of TransferRouteRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException