Package com.adyen.model.transferwebhooks

Class TransferData

  • public class TransferData
extends Object
    TransferData

    • Constructor Detail

      • TransferData

        public TransferData()

    • Method Detail

      • accountHolder

        public TransferData accountHolder​(ResourceReference accountHolder)
        accountHolder
        Parameters:
        accountHolder -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getAccountHolder

        public ResourceReference getAccountHolder()
        accountHolder
        Returns:
        accountHolder

      • setAccountHolder

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

      • amount

        public TransferData amount​(Amount amount)
        amount
        Parameters:
        amount -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getAmount

        public Amount getAmount()
        amount
        Returns:
        amount

      • setAmount

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

      • balanceAccount

        public TransferData balanceAccount​(ResourceReference balanceAccount)
        balanceAccount
        Parameters:
        balanceAccount -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getBalanceAccount

        public ResourceReference getBalanceAccount()
        balanceAccount
        Returns:
        balanceAccount

      • setBalanceAccount

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

      • balancePlatform

        public TransferData balancePlatform​(String balancePlatform)
        The unique identifier of the balance platform.
        Parameters:
        balancePlatform -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • balances

        public TransferData balances​(List<BalanceMutation> balances)
        The list of the latest balance statuses in the transfer.
        Parameters:
        balances -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • category

        public TransferData category​(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. - **card**: a transfer involving a third-party card. - **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. - **topUp**: an incoming transfer initiated by your user to top up their balance account.
        Parameters:
        category -
        Returns:
        the current TransferData instance, allowing for method chaining

      • 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. - **card**: a transfer involving a third-party card. - **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. - **topUp**: an incoming transfer initiated by your user to top up their balance account.
        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. - **card**: a transfer involving a third-party card. - **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. - **topUp**: an incoming transfer initiated by your user to top up their balance account.
        Parameters:
        category -

      • categoryData

        public TransferData categoryData​(TransferDataCategoryData categoryData)
        categoryData
        Parameters:
        categoryData -
        Returns:
        the current TransferData instance, allowing for method chaining

      • setCategoryData

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

      • creationDate

        public TransferData creationDate​(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 -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • description

        public TransferData description​(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 -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • directDebitInformation

        public TransferData directDebitInformation​(DirectDebitInformation directDebitInformation)
        directDebitInformation
        Parameters:
        directDebitInformation -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getDirectDebitInformation

        public DirectDebitInformation getDirectDebitInformation()
        directDebitInformation
        Returns:
        directDebitInformation

      • setDirectDebitInformation

        public void setDirectDebitInformation​(DirectDebitInformation directDebitInformation)
        directDebitInformation
        Parameters:
        directDebitInformation -

      • direction

        public TransferData direction​(TransferData.DirectionEnum direction)
        The direction of the transfer. Possible values: **incoming**, **outgoing**.
        Parameters:
        direction -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • eventId

        public TransferData eventId​(String eventId)
        The event id listed under events, that triggered the notification.
        Parameters:
        eventId -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getEventId

        public String getEventId()
        The event id listed under events, that triggered the notification.
        Returns:
        eventId

      • setEventId

        public void setEventId​(String eventId)
        The event id listed under events, that triggered the notification.
        Parameters:
        eventId -

      • events

        public TransferData events​(List<TransferEvent> events)
        The list of events leading up to the current status of the transfer.
        Parameters:
        events -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • id

        public TransferData id​(String id)
        The ID of the resource.
        Parameters:
        id -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getId

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

      • setId

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

      • paymentInstrument

        public TransferData paymentInstrument​(PaymentInstrument paymentInstrument)
        paymentInstrument
        Parameters:
        paymentInstrument -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getPaymentInstrument

        public PaymentInstrument getPaymentInstrument()
        paymentInstrument
        Returns:
        paymentInstrument

      • setPaymentInstrument

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

      • reason

        public TransferData reason​(TransferData.ReasonEnum reason)
        Additional information about the status of the transfer.
        Parameters:
        reason -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • reference

        public TransferData reference​(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 -
        Returns:
        the current TransferData instance, allowing for method chaining

      • 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)
        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 -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • review

        public TransferData review​(TransferReview review)
        review
        Parameters:
        review -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getReview

        public TransferReview getReview()
        review
        Returns:
        review

      • setReview

        public void setReview​(TransferReview review)
        review
        Parameters:
        review -

      • sequenceNumber

        public TransferData sequenceNumber​(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 -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • status

        public TransferData status​(TransferData.StatusEnum status)
        The result of the transfer. For example, **authorised**, **refused**, or **error**.
        Parameters:
        status -
        Returns:
        the current TransferData instance, allowing for method chaining

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

      • tracking

        public TransferData tracking​(TransferDataTracking tracking)
        tracking
        Parameters:
        tracking -
        Returns:
        the current TransferData instance, allowing for method chaining

      • setTracking

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

      • transactionRulesResult

        public TransferData transactionRulesResult​(TransactionRulesResult transactionRulesResult)
        transactionRulesResult
        Parameters:
        transactionRulesResult -
        Returns:
        the current TransferData instance, allowing for method chaining

      • getTransactionRulesResult

        public TransactionRulesResult getTransactionRulesResult()
        transactionRulesResult
        Returns:
        transactionRulesResult

      • setTransactionRulesResult

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

      • type

        public TransferData type​(TransferData.TypeEnum type)
        The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**.
        Parameters:
        type -
        Returns:
        the current TransferData instance, allowing for method chaining

      • 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