Package com.adyen.model.transfers

Class TransferInfo

  • public class TransferInfo
extends Object
    TransferInfo

    • Constructor Detail

      • TransferInfo

        public TransferInfo()

    • Method Detail

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

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

      • getBalanceAccountId

        public String getBalanceAccountId()
        The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
        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).
        Parameters:
        balanceAccountId -

      • getCategory

        public TransferInfo.CategoryEnum getCategory()
        The type of transfer. Possible values: - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: a transfer initiated by a Adyen-issued card. - **platformPayment**: funds movements related to payments that are acquired for your users.
        Returns:
        category

      • setCategory

        public void setCategory​(TransferInfo.CategoryEnum category)
        The type of transfer. Possible values: - **bank**: a transfer involving a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: a transfer between [balance accounts](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: a transfer initiated by a Adyen-issued card. - **platformPayment**: funds movements related to payments that are acquired for your users.
        Parameters:
        category -

      • getCounterparty

        public CounterpartyInfoV3 getCounterparty()
        Get counterparty
        Returns:
        counterparty

      • setCounterparty

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

      • getDescription

        public String getDescription()
        Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ ' \" ! ?**
        Returns:
        description

      • setDescription

        public void setDescription​(String description)
        Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ ' \" ! ?**
        Parameters:
        description -

      • paymentInstrumentId

        public TransferInfo paymentInstrumentId​(String paymentInstrumentId)

      • getPaymentInstrumentId

        public String getPaymentInstrumentId()
        The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
        Returns:
        paymentInstrumentId

      • setPaymentInstrumentId

        public void setPaymentInstrumentId​(String paymentInstrumentId)
        The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id).
        Parameters:
        paymentInstrumentId -

      • getPriority

        public TransferInfo.PriorityEnum getPriority()
        The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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:
        priority

      • setPriority

        public void setPriority​(TransferInfo.PriorityEnum priority)
        The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. 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:
        priority -

      • getReference

        public String getReference()
        Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
        Returns:
        reference

      • setReference

        public void setReference​(String reference)
        Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.
        Parameters:
        reference -

      • referenceForBeneficiary

        public TransferInfo referenceForBeneficiary​(String referenceForBeneficiary)

      • getReferenceForBeneficiary

        public String getReferenceForBeneficiary()
        A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others.
        Returns:
        referenceForBeneficiary

      • setReferenceForBeneficiary

        public void setReferenceForBeneficiary​(String referenceForBeneficiary)
        A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others.
        Parameters:
        referenceForBeneficiary -

      • setUltimateParty

        public void setUltimateParty​(UltimatePartyIdentification ultimateParty)
        ultimateParty
        Parameters:
        ultimateParty -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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