Package com.adyen.model.transfers

Class TransferData

  • public class TransferData
extends Object
    TransferData

    • Constructor Detail

      • TransferData

        public TransferData()

    • Method Detail

      • getAccountHolder

        public ResourceReference getAccountHolder()
        Get accountHolder
        Returns:
        accountHolder

      • setAccountHolder

        public void setAccountHolder​(ResourceReference accountHolder)
        accountHolder
        Parameters:
        accountHolder -

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

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

      • getBalanceAccount

        public ResourceReference getBalanceAccount()
        Get balanceAccount
        Returns:
        balanceAccount

      • setBalanceAccount

        public void setBalanceAccount​(ResourceReference balanceAccount)
        balanceAccount
        Parameters:
        balanceAccount -

      • getBalancePlatform

        public String getBalancePlatform()
        The unique identifier of the balance platform.
        Returns:
        balancePlatform

      • setBalancePlatform

        public void setBalancePlatform​(String balancePlatform)
        The unique identifier of the balance platform.
        Parameters:
        balancePlatform -

      • getBalances

        public List<BalanceMutation> getBalances()
        The list of the latest balance statuses in the transfer.
        Returns:
        balances

      • setBalances

        public void setBalances​(List<BalanceMutation> balances)
        The list of the latest balance statuses in the transfer.
        Parameters:
        balances -

      • getCategory

        public TransferData.CategoryEnum getCategory()
        The category of the 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 an Adyen-issued card. - **platformPayment**: funds movements related to payments that are acquired for your users.
        Returns:
        category

      • setCategory

        public void setCategory​(TransferData.CategoryEnum category)
        The category of the 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 an Adyen-issued card. - **platformPayment**: funds movements related to payments that are acquired for your users.
        Parameters:
        category -

      • getCategoryData

        public TransferCategoryData getCategoryData()
        Get categoryData
        Returns:
        categoryData

      • setCategoryData

        public void setCategoryData​(TransferCategoryData categoryData)
        categoryData
        Parameters:
        categoryData -

      • 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)
        The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
        Parameters:
        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)
        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 -

      • getDirection

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

      • setDirection

        public void setDirection​(TransferData.DirectionEnum direction)
        The direction of the transfer. Possible values: **incoming**, **outgoing**.
        Parameters:
        direction -

      • getEvents

        public List<TransferEvent> getEvents()
        The list of events leading up to the current status of the transfer.
        Returns:
        events

      • setEvents

        public void setEvents​(List<TransferEvent> events)
        The list of events leading up to the current status of the transfer.
        Parameters:
        events -

      • getId

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

      • setId

        public void setId​(String id)
        The ID of the resource.
        Parameters:
        id -

      • getPaymentInstrument

        public PaymentInstrument getPaymentInstrument()
        Get paymentInstrument
        Returns:
        paymentInstrument

      • setPaymentInstrument

        public void setPaymentInstrument​(PaymentInstrument paymentInstrument)
        paymentInstrument
        Parameters:
        paymentInstrument -

      • getReason

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

      • setReason

        public void setReason​(TransferData.ReasonEnum reason)
        Additional information about the status of the transfer.
        Parameters:
        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)
        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 TransferData 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)
        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.
        Parameters:
        referenceForBeneficiary -

      • getSequenceNumber

        public Integer getSequenceNumber()
        The sequence number of the transfer webhook. The numbers start from 1 and increase with each new webhook for a specific transfer. The sequence number can help you restore the correct sequence of events even if they arrive out of order.
        Returns:
        sequenceNumber

      • setSequenceNumber

        public void setSequenceNumber​(Integer sequenceNumber)
        The sequence number of the transfer webhook. The numbers start from 1 and increase with each new webhook for a specific transfer. The sequence number can help you restore the correct sequence of events even if they arrive out of order.
        Parameters:
        sequenceNumber -

      • getStatus

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

      • setStatus

        public void setStatus​(TransferData.StatusEnum status)
        The result of the transfer. For example, **authorised**, **refused**, or **error**.
        Parameters:
        status -

      • setTracking

        public void setTracking​(TransferDataTracking tracking)
        tracking
        Parameters:
        tracking -

      • getTransactionRulesResult

        public TransactionRulesResult getTransactionRulesResult()
        Get transactionRulesResult
        Returns:
        transactionRulesResult

      • setTransactionRulesResult

        public void setTransactionRulesResult​(TransactionRulesResult transactionRulesResult)
        transactionRulesResult
        Parameters:
        transactionRulesResult -

      • getType

        public TransferData.TypeEnum getType()
        The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**.
        Returns:
        type

      • setType

        public void setType​(TransferData.TypeEnum type)
        The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**.
        Parameters:
        type -

      • equals

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fromJson

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

      • toJson

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