Package com.adyen.model.transferwebhooks
Class TransferData
- java.lang.Object
-
- com.adyen.model.transferwebhooks.TransferData
-
public class TransferData extends Object
TransferData
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransferData.CategoryEnumThe type of transfer.static classTransferData.DirectionEnumThe direction of the transfer.static classTransferData.PanEntryModeEnumIndicates the method used for entering the PAN to initiate a transaction.static classTransferData.PlatformPaymentTypeEnumThe type of the related split.static classTransferData.PriorityEnumThe priority for the bank transfer.static classTransferData.ProcessingTypeEnumContains information about how the payment was processed.static classTransferData.ReasonEnumAdditional information about the status of the transfer.static classTransferData.StatusEnumThe result of the transfer.static classTransferData.TypeEnumThe type of transfer or transaction.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description TransferData()
-
Method Summary
-
-
-
Field Detail
-
JSON_PROPERTY_ACCOUNT_HOLDER
public static final String JSON_PROPERTY_ACCOUNT_HOLDER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BALANCE_ACCOUNT
public static final String JSON_PROPERTY_BALANCE_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BALANCE_ACCOUNT_ID
public static final String JSON_PROPERTY_BALANCE_ACCOUNT_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BALANCE_PLATFORM
public static final String JSON_PROPERTY_BALANCE_PLATFORM
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BALANCES
public static final String JSON_PROPERTY_BALANCES
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CATEGORY
public static final String JSON_PROPERTY_CATEGORY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COUNTERPARTY
public static final String JSON_PROPERTY_COUNTERPARTY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CREATION_DATE
public static final String JSON_PROPERTY_CREATION_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DIRECTION
public static final String JSON_PROPERTY_DIRECTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_EVENTS
public static final String JSON_PROPERTY_EVENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE
public static final String JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MODIFICATION_PSP_REFERENCE
public static final String JSON_PROPERTY_MODIFICATION_PSP_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAN_ENTRY_MODE
public static final String JSON_PROPERTY_PAN_ENTRY_MODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_INSTRUMENT
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_INSTRUMENT_ID
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENT_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE
public static final String JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PLATFORM_PAYMENT_TYPE
public static final String JSON_PROPERTY_PLATFORM_PAYMENT_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PRIORITY
public static final String JSON_PROPERTY_PRIORITY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PROCESSING_TYPE
public static final String JSON_PROPERTY_PROCESSING_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PSP_PAYMENT_REFERENCE
public static final String JSON_PROPERTY_PSP_PAYMENT_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REASON
public static final String JSON_PROPERTY_REASON
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY
public static final String JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RELAYED_AUTHORISATION_DATA
public static final String JSON_PROPERTY_RELAYED_AUTHORISATION_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SEQUENCE_NUMBER
public static final String JSON_PROPERTY_SEQUENCE_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STATUS
public static final String JSON_PROPERTY_STATUS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRACKING
public static final String JSON_PROPERTY_TRACKING
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRANSACTION_ID
public static final String JSON_PROPERTY_TRANSACTION_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRANSACTION_RULES_RESULT
public static final String JSON_PROPERTY_TRANSACTION_RULES_RESULT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VALIDATION_FACTS
public static final String JSON_PROPERTY_VALIDATION_FACTS
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountHolder
public TransferData accountHolder(ResourceReference accountHolder)
-
getAccountHolder
public ResourceReference getAccountHolder()
Get accountHolder- Returns:
- accountHolder
-
setAccountHolder
public void setAccountHolder(ResourceReference accountHolder)
-
amount
public TransferData amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
-
balanceAccount
public TransferData balanceAccount(ResourceReference balanceAccount)
-
getBalanceAccount
public ResourceReference getBalanceAccount()
Get balanceAccount- Returns:
- balanceAccount
-
setBalanceAccount
public void setBalanceAccount(ResourceReference balanceAccount)
-
balanceAccountId
public TransferData 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.
-
balancePlatform
public TransferData balancePlatform(String balancePlatform)
-
getBalancePlatform
public String getBalancePlatform()
The unique identifier of the balance platform.- Returns:
- balancePlatform
-
setBalancePlatform
public void setBalancePlatform(String balancePlatform)
-
balances
public TransferData balances(List<BalanceMutation> balances)
-
addBalancesItem
public TransferData addBalancesItem(BalanceMutation balancesItem)
-
getBalances
public List<BalanceMutation> getBalances()
The list of the latest balance statuses in the transfer.- Returns:
- balances
-
setBalances
public void setBalances(List<BalanceMutation> balances)
-
category
public TransferData category(TransferData.CategoryEnum category)
-
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
-
setCategory
public void setCategory(TransferData.CategoryEnum category)
-
counterparty
public TransferData counterparty(CounterpartyV3 counterparty)
-
getCounterparty
public CounterpartyV3 getCounterparty()
Get counterparty- Returns:
- counterparty
-
setCounterparty
public void setCounterparty(CounterpartyV3 counterparty)
-
creationDate
public TransferData creationDate(OffsetDateTime creationDate)
-
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)
-
description
public TransferData description(String description)
-
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)
-
direction
public TransferData direction(TransferData.DirectionEnum direction)
-
getDirection
public TransferData.DirectionEnum getDirection()
The direction of the transfer. Possible values: **incoming**, **outgoing**.- Returns:
- direction
-
setDirection
public void setDirection(TransferData.DirectionEnum direction)
-
events
public TransferData events(List<TransferEvent> events)
-
addEventsItem
public TransferData addEventsItem(TransferEvent eventsItem)
-
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)
-
id
public TransferData id(String id)
-
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.
-
panEntryMode
public TransferData panEntryMode(TransferData.PanEntryModeEnum panEntryMode)
-
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
-
setPanEntryMode
@Deprecated public void setPanEntryMode(TransferData.PanEntryModeEnum panEntryMode)
Deprecated.
-
paymentInstrument
public TransferData paymentInstrument(PaymentInstrument paymentInstrument)
-
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.
-
platformPaymentType
public TransferData platformPaymentType(TransferData.PlatformPaymentTypeEnum platformPaymentType)
-
getPlatformPaymentType
@Deprecated public TransferData.PlatformPaymentTypeEnum getPlatformPaymentType()
Deprecated.The type of the related split.- Returns:
- platformPaymentType
-
setPlatformPaymentType
@Deprecated public void setPlatformPaymentType(TransferData.PlatformPaymentTypeEnum platformPaymentType)
Deprecated.
-
priority
public TransferData priority(TransferData.PriorityEnum priority)
-
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
-
setPriority
public void setPriority(TransferData.PriorityEnum priority)
-
processingType
public TransferData processingType(TransferData.ProcessingTypeEnum processingType)
-
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
-
setProcessingType
@Deprecated public void setProcessingType(TransferData.ProcessingTypeEnum processingType)
Deprecated.
-
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.
-
reason
public TransferData reason(TransferData.ReasonEnum reason)
-
getReason
public TransferData.ReasonEnum getReason()
Additional information about the status of the transfer.- Returns:
- reason
-
setReason
public void setReason(TransferData.ReasonEnum reason)
-
reference
public TransferData reference(String reference)
-
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)
-
relayedAuthorisationData
public TransferData relayedAuthorisationData(RelayedAuthorisationData relayedAuthorisationData)
-
getRelayedAuthorisationData
public RelayedAuthorisationData getRelayedAuthorisationData()
Get relayedAuthorisationData- Returns:
- relayedAuthorisationData
-
setRelayedAuthorisationData
public void setRelayedAuthorisationData(RelayedAuthorisationData relayedAuthorisationData)
-
sequenceNumber
public TransferData sequenceNumber(Integer sequenceNumber)
-
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)
-
status
public TransferData status(TransferData.StatusEnum status)
-
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)
-
tracking
public TransferData tracking(TransferNotificationTransferTracking tracking)
-
getTracking
public TransferNotificationTransferTracking getTracking()
Get tracking- Returns:
- tracking
-
setTracking
public void setTracking(TransferNotificationTransferTracking tracking)
-
transactionId
public TransferData transactionId(String transactionId)
-
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.
-
transactionRulesResult
public TransferData transactionRulesResult(TransactionRulesResult transactionRulesResult)
-
getTransactionRulesResult
public TransactionRulesResult getTransactionRulesResult()
Get transactionRulesResult- Returns:
- transactionRulesResult
-
setTransactionRulesResult
public void setTransactionRulesResult(TransactionRulesResult transactionRulesResult)
-
type
public TransferData type(TransferData.TypeEnum type)
-
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)
-
validationFacts
public TransferData validationFacts(List<TransferNotificationValidationFact> validationFacts)
-
addValidationFactsItem
public TransferData addValidationFactsItem(TransferNotificationValidationFact validationFactsItem)
-
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
-
setValidationFacts
@Deprecated public void setValidationFacts(List<TransferNotificationValidationFact> validationFacts)
Deprecated.
-
equals
public boolean equals(Object o)
Return true if this TransferData object is equal to o.
-
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
-
-