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 category of the transfer.static classTransferData.DirectionEnumThe direction of the transfer.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
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACCOUNT_HOLDERstatic StringJSON_PROPERTY_AMOUNTstatic StringJSON_PROPERTY_BALANCE_ACCOUNTstatic StringJSON_PROPERTY_BALANCE_PLATFORMstatic StringJSON_PROPERTY_BALANCESstatic StringJSON_PROPERTY_CATEGORYstatic StringJSON_PROPERTY_CATEGORY_DATAstatic StringJSON_PROPERTY_COUNTERPARTYstatic StringJSON_PROPERTY_CREATION_DATEstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_DIRECTIONstatic StringJSON_PROPERTY_EVENTSstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_PAYMENT_INSTRUMENTstatic StringJSON_PROPERTY_REASONstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_REFERENCE_FOR_BENEFICIARYstatic StringJSON_PROPERTY_SEQUENCE_NUMBERstatic StringJSON_PROPERTY_STATUSstatic StringJSON_PROPERTY_TRACKINGstatic StringJSON_PROPERTY_TRANSACTION_RULES_RESULTstatic StringJSON_PROPERTY_TYPE
-
Constructor Summary
Constructors Constructor Description TransferData()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TransferDataaccountHolder(ResourceReference accountHolder)TransferDataaddBalancesItem(BalanceMutation balancesItem)TransferDataaddEventsItem(TransferEvent eventsItem)TransferDataamount(Amount amount)TransferDatabalanceAccount(ResourceReference balanceAccount)TransferDatabalancePlatform(String balancePlatform)TransferDatabalances(List<BalanceMutation> balances)TransferDatacategory(TransferData.CategoryEnum category)TransferDatacategoryData(TransferDataCategoryData categoryData)TransferDatacounterparty(TransferNotificationCounterParty counterparty)TransferDatacreationDate(OffsetDateTime creationDate)TransferDatadescription(String description)TransferDatadirection(TransferData.DirectionEnum direction)booleanequals(Object o)Return true if this TransferData object is equal to o.TransferDataevents(List<TransferEvent> events)static TransferDatafromJson(String jsonString)Create an instance of TransferData given an JSON stringResourceReferencegetAccountHolder()Get accountHolderAmountgetAmount()Get amountResourceReferencegetBalanceAccount()Get balanceAccountStringgetBalancePlatform()The unique identifier of the balance platform.List<BalanceMutation>getBalances()The list of the latest balance statuses in the transfer.TransferData.CategoryEnumgetCategory()The category of the transfer.TransferDataCategoryDatagetCategoryData()Get categoryDataTransferNotificationCounterPartygetCounterparty()Get counterpartyOffsetDateTimegetCreationDate()The date and time when the event was triggered, in ISO 8601 extended format.StringgetDescription()Your description for the transfer.TransferData.DirectionEnumgetDirection()The direction of the transfer.List<TransferEvent>getEvents()The list of events leading up to the current status of the transfer.StringgetId()The ID of the resource.PaymentInstrumentgetPaymentInstrument()Get paymentInstrumentTransferData.ReasonEnumgetReason()Additional information about the status of the transfer.StringgetReference()Your reference for the transfer, used internally within your platform.StringgetReferenceForBeneficiary()A reference that is sent to the recipient.IntegergetSequenceNumber()The sequence number of the transfer webhook.TransferData.StatusEnumgetStatus()The result of the transfer.TransferDataTrackinggetTracking()Get trackingTransactionRulesResultgetTransactionRulesResult()Get transactionRulesResultTransferData.TypeEnumgetType()The type of transfer or transaction.inthashCode()TransferDataid(String id)TransferDatapaymentInstrument(PaymentInstrument paymentInstrument)TransferDatareason(TransferData.ReasonEnum reason)TransferDatareference(String reference)TransferDatareferenceForBeneficiary(String referenceForBeneficiary)TransferDatasequenceNumber(Integer sequenceNumber)voidsetAccountHolder(ResourceReference accountHolder)accountHoldervoidsetAmount(Amount amount)amountvoidsetBalanceAccount(ResourceReference balanceAccount)balanceAccountvoidsetBalancePlatform(String balancePlatform)The unique identifier of the balance platform.voidsetBalances(List<BalanceMutation> balances)The list of the latest balance statuses in the transfer.voidsetCategory(TransferData.CategoryEnum category)The category of the transfer.voidsetCategoryData(TransferDataCategoryData categoryData)categoryDatavoidsetCounterparty(TransferNotificationCounterParty counterparty)counterpartyvoidsetCreationDate(OffsetDateTime creationDate)The date and time when the event was triggered, in ISO 8601 extended format.voidsetDescription(String description)Your description for the transfer.voidsetDirection(TransferData.DirectionEnum direction)The direction of the transfer.voidsetEvents(List<TransferEvent> events)The list of events leading up to the current status of the transfer.voidsetId(String id)The ID of the resource.voidsetPaymentInstrument(PaymentInstrument paymentInstrument)paymentInstrumentvoidsetReason(TransferData.ReasonEnum reason)Additional information about the status of the transfer.voidsetReference(String reference)Your reference for the transfer, used internally within your platform.voidsetReferenceForBeneficiary(String referenceForBeneficiary)A reference that is sent to the recipient.voidsetSequenceNumber(Integer sequenceNumber)The sequence number of the transfer webhook.voidsetStatus(TransferData.StatusEnum status)The result of the transfer.voidsetTracking(TransferDataTracking tracking)trackingvoidsetTransactionRulesResult(TransactionRulesResult transactionRulesResult)transactionRulesResultvoidsetType(TransferData.TypeEnum type)The type of transfer or transaction.TransferDatastatus(TransferData.StatusEnum status)StringtoJson()Convert an instance of TransferData to an JSON stringStringtoString()TransferDatatracking(TransferDataTracking tracking)TransferDatatransactionRulesResult(TransactionRulesResult transactionRulesResult)TransferDatatype(TransferData.TypeEnum type)
-
-
-
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_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_CATEGORY_DATA
public static final String JSON_PROPERTY_CATEGORY_DATA
- 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_PAYMENT_INSTRUMENT
public static final String JSON_PROPERTY_PAYMENT_INSTRUMENT
- 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_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_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
-
-
Method Detail
-
accountHolder
public TransferData accountHolder(ResourceReference accountHolder)
-
getAccountHolder
public ResourceReference getAccountHolder()
Get accountHolder- Returns:
- accountHolder
-
setAccountHolder
public void setAccountHolder(ResourceReference accountHolder)
accountHolder- Parameters:
accountHolder-
-
amount
public TransferData amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
amount- Parameters:
amount-
-
balanceAccount
public TransferData balanceAccount(ResourceReference balanceAccount)
-
getBalanceAccount
public ResourceReference getBalanceAccount()
Get balanceAccount- Returns:
- balanceAccount
-
setBalanceAccount
public void setBalanceAccount(ResourceReference balanceAccount)
balanceAccount- Parameters:
balanceAccount-
-
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)
The unique identifier of the balance platform.- Parameters:
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)
The list of the latest balance statuses in the transfer.- Parameters:
balances-
-
category
public TransferData category(TransferData.CategoryEnum category)
-
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-
-
categoryData
public TransferData categoryData(TransferDataCategoryData categoryData)
-
getCategoryData
public TransferDataCategoryData getCategoryData()
Get categoryData- Returns:
- categoryData
-
setCategoryData
public void setCategoryData(TransferDataCategoryData categoryData)
categoryData- Parameters:
categoryData-
-
counterparty
public TransferData counterparty(TransferNotificationCounterParty counterparty)
-
getCounterparty
public TransferNotificationCounterParty getCounterparty()
Get counterparty- Returns:
- counterparty
-
setCounterparty
public void setCounterparty(TransferNotificationCounterParty counterparty)
counterparty- Parameters:
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)
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)
-
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-
-
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)
The direction of the transfer. Possible values: **incoming**, **outgoing**.- Parameters:
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)
The list of events leading up to the current status of the transfer.- Parameters:
events-
-
id
public TransferData id(String id)
-
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)
-
getPaymentInstrument
public PaymentInstrument getPaymentInstrument()
Get paymentInstrument- Returns:
- paymentInstrument
-
setPaymentInstrument
public void setPaymentInstrument(PaymentInstrument paymentInstrument)
paymentInstrument- Parameters:
paymentInstrument-
-
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)
Additional information about the status of the transfer.- Parameters:
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)
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-
-
sequenceNumber
public TransferData sequenceNumber(Integer sequenceNumber)
-
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)
-
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)
-
getTracking
public TransferDataTracking getTracking()
Get tracking- Returns:
- tracking
-
setTracking
public void setTracking(TransferDataTracking tracking)
tracking- Parameters:
tracking-
-
transactionRulesResult
public TransferData transactionRulesResult(TransactionRulesResult transactionRulesResult)
-
getTransactionRulesResult
public TransactionRulesResult getTransactionRulesResult()
Get transactionRulesResult- Returns:
- transactionRulesResult
-
setTransactionRulesResult
public void setTransactionRulesResult(TransactionRulesResult transactionRulesResult)
transactionRulesResult- Parameters:
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)
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.
-
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
-
-