Package com.adyen.model.transfers

Class Transfer

  • public class Transfer
extends Object
    Transfer

    • Constructor Detail

      • Transfer

        public Transfer()

    • Method Detail

      • getAccountHolder

        public ResourceReference getAccountHolder()
        Get accountHolder
        Returns:
        accountHolder

      • setAccountHolder

        public void setAccountHolder​(ResourceReference accountHolder)

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

        public void setAmount​(Amount amount)

      • getBalanceAccount

        public ResourceReference getBalanceAccount()
        Get balanceAccount
        Returns:
        balanceAccount

      • setBalanceAccount

        public void setBalanceAccount​(ResourceReference balanceAccount)

      • balanceAccountId

        public Transfer balanceAccountId​(String balanceAccountId)

      • getBalanceAccountId

        @Deprecated
public String getBalanceAccountId()
        Deprecated.
        The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).
        Returns:
        balanceAccountId

      • setBalanceAccountId

        @Deprecated
public void setBalanceAccountId​(String balanceAccountId)
        Deprecated.

      • getCategory

        public Transfer.CategoryEnum getCategory()
        The category 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 CounterpartyV3 getCounterparty()
        Get counterparty
        Returns:
        counterparty

      • setCounterparty

        public void setCounterparty​(CounterpartyV3 counterparty)

      • getCreationDate

        public OffsetDateTime getCreationDate()
        The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
        Returns:
        creationDate

      • setCreationDate

        public void setCreationDate​(OffsetDateTime creationDate)

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

      • getDirection

        public Transfer.DirectionEnum getDirection()
        The direction of the transfer. Possible values: **incoming**, **outgoing**.
        Returns:
        direction

      • getId

        public String getId()
        The ID of the resource.
        Returns:
        id

      • setId

        public void setId​(String id)

      • getPaymentInstrument

        public PaymentInstrument getPaymentInstrument()
        Get paymentInstrument
        Returns:
        paymentInstrument

      • setPaymentInstrument

        public void setPaymentInstrument​(PaymentInstrument paymentInstrument)

      • paymentInstrumentId

        public Transfer paymentInstrumentId​(String paymentInstrumentId)

      • getPaymentInstrumentId

        @Deprecated
public String getPaymentInstrumentId()
        Deprecated.
        The unique identifier of the [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) used in the transfer.
        Returns:
        paymentInstrumentId

      • setPaymentInstrumentId

        @Deprecated
public void setPaymentInstrumentId​(String paymentInstrumentId)
        Deprecated.

      • getPriority

        public Transfer.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). This will be removed in v4 and replaced with a new field.
        Returns:
        priority

      • getReason

        public Transfer.ReasonEnum getReason()
        Additional information about the status of the transfer.
        Returns:
        reason

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

      • getStatus

        public Transfer.StatusEnum getStatus()
        The result of the transfer. For example, **authorised**, **refused**, or **error**.
        Returns:
        status

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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