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)

      • 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)

      • getCategory

        public TransferInfo.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. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users.
        Returns:
        category

      • getCounterparty

        public CounterpartyInfoV3 getCounterparty()
        Get counterparty
        Returns:
        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)

      • 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)

      • 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**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN).
        Returns:
        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)

      • 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 the source and recipient of funds. 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)

      • 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