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

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

        public void setBalancePlatform​(String balancePlatform)
      • getBalances

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

        public TransferData.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 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 TransferData.DirectionEnum getDirection()
        The direction of the transfer. Possible values: **incoming**, **outgoing**.
        Returns:
        direction
      • getEvents

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

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

        public void setId​(String id)
      • modificationMerchantReference

        public TransferData modificationMerchantReference​(String modificationMerchantReference)
      • getModificationMerchantReference

        @Deprecated
        public String getModificationMerchantReference()
        Deprecated.
        The capture's merchant reference included in the transfer.
        Returns:
        modificationMerchantReference
      • setModificationMerchantReference

        @Deprecated
        public void setModificationMerchantReference​(String modificationMerchantReference)
        Deprecated.
      • modificationPspReference

        public TransferData modificationPspReference​(String modificationPspReference)
      • getModificationPspReference

        @Deprecated
        public String getModificationPspReference()
        Deprecated.
        The capture reference included in the transfer.
        Returns:
        modificationPspReference
      • setModificationPspReference

        @Deprecated
        public void setModificationPspReference​(String modificationPspReference)
        Deprecated.
      • getPanEntryMode

        @Deprecated
        public TransferData.PanEntryModeEnum getPanEntryMode()
        Deprecated.
        Indicates the method used for entering the PAN to initiate a transaction. Possible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**.
        Returns:
        panEntryMode
      • getPaymentInstrument

        public PaymentInstrument getPaymentInstrument()
        Get paymentInstrument
        Returns:
        paymentInstrument
      • setPaymentInstrument

        public void setPaymentInstrument​(PaymentInstrument paymentInstrument)
      • paymentInstrumentId

        public TransferData 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.
      • paymentMerchantReference

        public TransferData paymentMerchantReference​(String paymentMerchantReference)
      • getPaymentMerchantReference

        @Deprecated
        public String getPaymentMerchantReference()
        Deprecated.
        The payment's merchant reference included in the transfer.
        Returns:
        paymentMerchantReference
      • setPaymentMerchantReference

        @Deprecated
        public void setPaymentMerchantReference​(String paymentMerchantReference)
        Deprecated.
      • getPriority

        public TransferData.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
      • getProcessingType

        @Deprecated
        public TransferData.ProcessingTypeEnum getProcessingType()
        Deprecated.
        Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for in-person payments.
        Returns:
        processingType
      • pspPaymentReference

        public TransferData pspPaymentReference​(String pspPaymentReference)
      • getPspPaymentReference

        @Deprecated
        public String getPspPaymentReference()
        Deprecated.
        The payment reference included in the transfer.
        Returns:
        pspPaymentReference
      • setPspPaymentReference

        @Deprecated
        public void setPspPaymentReference​(String pspPaymentReference)
        Deprecated.
      • getReason

        public TransferData.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 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)
      • getRelayedAuthorisationData

        public RelayedAuthorisationData getRelayedAuthorisationData()
        Get relayedAuthorisationData
        Returns:
        relayedAuthorisationData
      • setRelayedAuthorisationData

        public void setRelayedAuthorisationData​(RelayedAuthorisationData relayedAuthorisationData)
      • getSequenceNumber

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

        public void setSequenceNumber​(Integer sequenceNumber)
      • getStatus

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

        @Deprecated
        public String getTransactionId()
        Deprecated.
        The ID of the transaction that is created based on the transfer.
        Returns:
        transactionId
      • setTransactionId

        @Deprecated
        public void setTransactionId​(String transactionId)
        Deprecated.
      • getTransactionRulesResult

        public TransactionRulesResult getTransactionRulesResult()
        Get transactionRulesResult
        Returns:
        transactionRulesResult
      • setTransactionRulesResult

        public void setTransactionRulesResult​(TransactionRulesResult transactionRulesResult)
      • getType

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

        @Deprecated
        public List<TransferNotificationValidationFact> getValidationFacts()
        Deprecated.
        The evaluation of the validation facts. See [validation checks](https://docs.adyen.com/issuing/validation-checks) for more information.
        Returns:
        validationFacts
      • 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