Package com.adyen.model.transfers

Class Transfer

  • public class Transfer
extends Object
    Transfer

    • Constructor Detail

      • Transfer

        public Transfer()

    • Method Detail

      • accountHolder

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

      • getAccountHolder

        public ResourceReference getAccountHolder()
        Get accountHolder
        Returns:
        accountHolder

      • setAccountHolder

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

      • amount

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

      • getAmount

        public Amount getAmount()
        Get amount
        Returns:
        amount

      • setAmount

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

      • balanceAccount

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

      • getBalanceAccount

        public ResourceReference getBalanceAccount()
        Get balanceAccount
        Returns:
        balanceAccount

      • setBalanceAccount

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

      • category

        public Transfer category​(Transfer.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#responses-200-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#responses-200-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. - **topUp**: An incoming transfer initiated by your user to top up their balance account.
        Parameters:
        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#responses-200-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#responses-200-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. - **topUp**: An incoming transfer initiated by your user to top up their balance account.
        Returns:
        the current Transfer instance, allowing for method chaining

      • getCategory

        public Transfer.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#responses-200-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#responses-200-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. - **topUp**: An incoming transfer initiated by your user to top up their balance account.
        Returns:
        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#responses-200-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#responses-200-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. - **topUp**: An incoming transfer initiated by your user to top up their balance account.

      • setCategory

        public void setCategory​(Transfer.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#responses-200-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#responses-200-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. - **topUp**: An incoming transfer initiated by your user to top up their balance account.
        Parameters:
        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#responses-200-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#responses-200-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. - **topUp**: An incoming transfer initiated by your user to top up their balance account.

      • categoryData

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

      • getCategoryData

        public TransferCategoryData getCategoryData()
        Get categoryData
        Returns:
        categoryData

      • setCategoryData

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

      • counterparty

        public Transfer counterparty​(CounterpartyV3 counterparty)
        counterparty
        Parameters:
        counterparty -
        Returns:
        the current Transfer instance, allowing for method chaining

      • getCounterparty

        public CounterpartyV3 getCounterparty()
        Get counterparty
        Returns:
        counterparty

      • setCounterparty

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

      • createdAt

        public Transfer createdAt​(OffsetDateTime createdAt)
        The date and time when the transfer was created, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
        Parameters:
        createdAt - The date and time when the transfer was created, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
        Returns:
        the current Transfer instance, allowing for method chaining

      • getCreatedAt

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

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)
        The date and time when the transfer was created, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
        Parameters:
        createdAt - The date and time when the transfer was created, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.

      • creationDate

        @Deprecated
public Transfer creationDate​(OffsetDateTime creationDate)
        Deprecated.
        since Transfers API v3 Use createdAt or updatedAt
        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 - The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.
        Returns:
        the current Transfer instance, allowing for method chaining

      • getCreationDate

        @Deprecated
public OffsetDateTime getCreationDate()
        Deprecated.
        // deprecated since Transfers API v3: Use createdAt or updatedAt
        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 The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.

      • setCreationDate

        @Deprecated
public void setCreationDate​(OffsetDateTime creationDate)
        Deprecated.
        since Transfers API v3 Use createdAt or updatedAt
        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 - The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**.

      • description

        public Transfer 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 - 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:
        the current Transfer 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 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] & $ % # @** **~ = + - _ ' \" ! ?**

      • 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 - 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] & $ % # @** **~ = + - _ ' \" ! ?**

      • directDebitInformation

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

      • getDirectDebitInformation

        public DirectDebitInformation getDirectDebitInformation()
        Get directDebitInformation
        Returns:
        directDebitInformation

      • setDirectDebitInformation

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

      • direction

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

      • getDirection

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

      • setDirection

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

      • executionDate

        public Transfer executionDate​(ExecutionDate executionDate)
        executionDate
        Parameters:
        executionDate -
        Returns:
        the current Transfer instance, allowing for method chaining

      • getExecutionDate

        public ExecutionDate getExecutionDate()
        Get executionDate
        Returns:
        executionDate

      • setExecutionDate

        public void setExecutionDate​(ExecutionDate executionDate)
        executionDate
        Parameters:
        executionDate -

      • id

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

      • getId

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

      • setId

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

      • paymentInstrument

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

      • getPaymentInstrument

        public PaymentInstrument getPaymentInstrument()
        Get paymentInstrument
        Returns:
        paymentInstrument

      • setPaymentInstrument

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

      • reason

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

      • getReason

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

      • setReason

        public void setReason​(Transfer.ReasonEnum reason)
        Additional information about the status of the transfer.
        Parameters:
        reason - Additional information about the status of the transfer.

      • reference

        public Transfer 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 - 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:
        the current Transfer 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 Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique 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 - Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference.

      • referenceForBeneficiary

        public Transfer 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 - 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:
        the current Transfer 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 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.

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

      • review

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

      • getReview

        public TransferReview getReview()
        Get review
        Returns:
        review

      • setReview

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

      • status

        public Transfer status​(Transfer.StatusEnum status)
        The result of the transfer. For example: - **received**: an outgoing transfer request is created. - **refused**: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - **authorised**: the transfer request is authorized and the funds are reserved. - **booked**: the funds are deducted from your user's balance account. - **failed**: the transfer is rejected by the counterparty's bank. - **returned**: the transfer is returned by the counterparty's bank.
        Parameters:
        status - The result of the transfer. For example: - **received**: an outgoing transfer request is created. - **refused**: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - **authorised**: the transfer request is authorized and the funds are reserved. - **booked**: the funds are deducted from your user's balance account. - **failed**: the transfer is rejected by the counterparty's bank. - **returned**: the transfer is returned by the counterparty's bank.
        Returns:
        the current Transfer instance, allowing for method chaining

      • getStatus

        public Transfer.StatusEnum getStatus()
        The result of the transfer. For example: - **received**: an outgoing transfer request is created. - **refused**: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - **authorised**: the transfer request is authorized and the funds are reserved. - **booked**: the funds are deducted from your user's balance account. - **failed**: the transfer is rejected by the counterparty's bank. - **returned**: the transfer is returned by the counterparty's bank.
        Returns:
        status The result of the transfer. For example: - **received**: an outgoing transfer request is created. - **refused**: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - **authorised**: the transfer request is authorized and the funds are reserved. - **booked**: the funds are deducted from your user's balance account. - **failed**: the transfer is rejected by the counterparty's bank. - **returned**: the transfer is returned by the counterparty's bank.

      • setStatus

        public void setStatus​(Transfer.StatusEnum status)
        The result of the transfer. For example: - **received**: an outgoing transfer request is created. - **refused**: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - **authorised**: the transfer request is authorized and the funds are reserved. - **booked**: the funds are deducted from your user's balance account. - **failed**: the transfer is rejected by the counterparty's bank. - **returned**: the transfer is returned by the counterparty's bank.
        Parameters:
        status - The result of the transfer. For example: - **received**: an outgoing transfer request is created. - **refused**: the transfer request is rejected by Adyen for one of the following reasons: - Lack of funds in the balance account. - Transfer limit exceeded. - Transaction rule requirements violated. - **authorised**: the transfer request is authorized and the funds are reserved. - **booked**: the funds are deducted from your user's balance account. - **failed**: the transfer is rejected by the counterparty's bank. - **returned**: the transfer is returned by the counterparty's bank.

      • type

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

      • getType

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

      • setType

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

      • includeNullValues

        public Transfer includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.

      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.

      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.

      • 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

      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.

      • 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