Package com.adyen.model.transferwebhooks
Class TransferNotificationData
- java.lang.Object
-
- com.adyen.model.transferwebhooks.TransferNotificationData
-
public class TransferNotificationData extends Object
TransferNotificationData
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransferNotificationData.CategoryEnumThe type of transfer.static classTransferNotificationData.CustomTypeAdapterFactorystatic classTransferNotificationData.DirectionEnumThe direction of the transfer.static classTransferNotificationData.PanEntryModeEnumIndicates the method used for entering the PAN to initiate a transaction.static classTransferNotificationData.PriorityEnumThe priority for the bank transfer.static classTransferNotificationData.ProcessingTypeEnumContains information about how the payment was processed.static classTransferNotificationData.ReasonEnumAdditional information about the status of the transfer.static classTransferNotificationData.StatusEnumThe result of the transfer.static classTransferNotificationData.TypeEnumThe type of transfer or transaction.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description TransferNotificationData()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_ACCOUNT_HOLDER
public static final String SERIALIZED_NAME_ACCOUNT_HOLDER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_AMOUNT
public static final String SERIALIZED_NAME_AMOUNT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BALANCE_ACCOUNT
public static final String SERIALIZED_NAME_BALANCE_ACCOUNT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BALANCE_ACCOUNT_ID
public static final String SERIALIZED_NAME_BALANCE_ACCOUNT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BALANCE_PLATFORM
public static final String SERIALIZED_NAME_BALANCE_PLATFORM
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BALANCES
public static final String SERIALIZED_NAME_BALANCES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CATEGORY
public static final String SERIALIZED_NAME_CATEGORY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_COUNTERPARTY
public static final String SERIALIZED_NAME_COUNTERPARTY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CREATION_DATE
public static final String SERIALIZED_NAME_CREATION_DATE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DESCRIPTION
public static final String SERIALIZED_NAME_DESCRIPTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DIRECTION
public static final String SERIALIZED_NAME_DIRECTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EVENTS
public static final String SERIALIZED_NAME_EVENTS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ID
public static final String SERIALIZED_NAME_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MODIFICATION_MERCHANT_REFERENCE
public static final String SERIALIZED_NAME_MODIFICATION_MERCHANT_REFERENCE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_MODIFICATION_PSP_REFERENCE
public static final String SERIALIZED_NAME_MODIFICATION_PSP_REFERENCE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PAN_ENTRY_MODE
public static final String SERIALIZED_NAME_PAN_ENTRY_MODE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PAYMENT_INSTRUMENT
public static final String SERIALIZED_NAME_PAYMENT_INSTRUMENT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID
public static final String SERIALIZED_NAME_PAYMENT_INSTRUMENT_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PAYMENT_MERCHANT_REFERENCE
public static final String SERIALIZED_NAME_PAYMENT_MERCHANT_REFERENCE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PRIORITY
public static final String SERIALIZED_NAME_PRIORITY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PROCESSING_TYPE
public static final String SERIALIZED_NAME_PROCESSING_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PSP_PAYMENT_REFERENCE
public static final String SERIALIZED_NAME_PSP_PAYMENT_REFERENCE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REASON
public static final String SERIALIZED_NAME_REASON
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REFERENCE
public static final String SERIALIZED_NAME_REFERENCE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY
public static final String SERIALIZED_NAME_REFERENCE_FOR_BENEFICIARY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_RELAYED_AUTHORISATION_DATA
public static final String SERIALIZED_NAME_RELAYED_AUTHORISATION_DATA
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_SEQUENCE_NUMBER
public static final String SERIALIZED_NAME_SEQUENCE_NUMBER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_STATUS
public static final String SERIALIZED_NAME_STATUS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TRACKING
public static final String SERIALIZED_NAME_TRACKING
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TRANSACTION_ID
public static final String SERIALIZED_NAME_TRANSACTION_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TRANSACTION_RULES_RESULT
public static final String SERIALIZED_NAME_TRANSACTION_RULES_RESULT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TYPE
public static final String SERIALIZED_NAME_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VALIDATION_FACTS
public static final String SERIALIZED_NAME_VALIDATION_FACTS
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountHolder
public TransferNotificationData accountHolder(ResourceReference accountHolder)
-
getAccountHolder
public ResourceReference getAccountHolder()
Get accountHolder- Returns:
- accountHolder
-
setAccountHolder
public void setAccountHolder(ResourceReference accountHolder)
-
amount
public TransferNotificationData amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
-
balanceAccount
public TransferNotificationData balanceAccount(ResourceReference balanceAccount)
-
getBalanceAccount
public ResourceReference getBalanceAccount()
Get balanceAccount- Returns:
- balanceAccount
-
setBalanceAccount
public void setBalanceAccount(ResourceReference balanceAccount)
-
balanceAccountId
@Deprecated public TransferNotificationData balanceAccountId(String balanceAccountId)
Deprecated.
-
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 TransferNotificationData balancePlatform(String balancePlatform)
-
getBalancePlatform
public String getBalancePlatform()
The unique identifier of the balance platform.- Returns:
- balancePlatform
-
setBalancePlatform
public void setBalancePlatform(String balancePlatform)
-
balances
public TransferNotificationData balances(List<BalanceMutation> balances)
-
addBalancesItem
public TransferNotificationData 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 TransferNotificationData category(TransferNotificationData.CategoryEnum category)
-
getCategory
public TransferNotificationData.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(TransferNotificationData.CategoryEnum category)
-
counterparty
public TransferNotificationData counterparty(CounterpartyV3 counterparty)
-
getCounterparty
public CounterpartyV3 getCounterparty()
Get counterparty- Returns:
- counterparty
-
setCounterparty
public void setCounterparty(CounterpartyV3 counterparty)
-
creationDate
public TransferNotificationData 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 TransferNotificationData 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 TransferNotificationData direction(TransferNotificationData.DirectionEnum direction)
-
getDirection
public TransferNotificationData.DirectionEnum getDirection()
The direction of the transfer. Possible values: **incoming**, **outgoing**.- Returns:
- direction
-
setDirection
public void setDirection(TransferNotificationData.DirectionEnum direction)
-
events
public TransferNotificationData events(List<TransferEvent> events)
-
addEventsItem
public TransferNotificationData 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 TransferNotificationData id(String id)
-
getId
public String getId()
The ID of the resource.- Returns:
- id
-
setId
public void setId(String id)
-
modificationMerchantReference
@Deprecated public TransferNotificationData modificationMerchantReference(String modificationMerchantReference)
Deprecated.
-
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
@Deprecated public TransferNotificationData modificationPspReference(String modificationPspReference)
Deprecated.
-
getModificationPspReference
@Deprecated public String getModificationPspReference()
Deprecated.The capture reference included in the transfer.- Returns:
- modificationPspReference
-
setModificationPspReference
@Deprecated public void setModificationPspReference(String modificationPspReference)
Deprecated.
-
panEntryMode
@Deprecated public TransferNotificationData panEntryMode(TransferNotificationData.PanEntryModeEnum panEntryMode)
Deprecated.
-
getPanEntryMode
@Deprecated public TransferNotificationData.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(TransferNotificationData.PanEntryModeEnum panEntryMode)
Deprecated.
-
paymentInstrument
public TransferNotificationData paymentInstrument(PaymentInstrument paymentInstrument)
-
getPaymentInstrument
public PaymentInstrument getPaymentInstrument()
Get paymentInstrument- Returns:
- paymentInstrument
-
setPaymentInstrument
public void setPaymentInstrument(PaymentInstrument paymentInstrument)
-
paymentInstrumentId
@Deprecated public TransferNotificationData paymentInstrumentId(String paymentInstrumentId)
Deprecated.
-
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
@Deprecated public TransferNotificationData paymentMerchantReference(String paymentMerchantReference)
Deprecated.
-
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.
-
priority
public TransferNotificationData priority(TransferNotificationData.PriorityEnum priority)
-
getPriority
public TransferNotificationData.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(TransferNotificationData.PriorityEnum priority)
-
processingType
@Deprecated public TransferNotificationData processingType(TransferNotificationData.ProcessingTypeEnum processingType)
Deprecated.
-
getProcessingType
@Deprecated public TransferNotificationData.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(TransferNotificationData.ProcessingTypeEnum processingType)
Deprecated.
-
pspPaymentReference
@Deprecated public TransferNotificationData pspPaymentReference(String pspPaymentReference)
Deprecated.
-
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 TransferNotificationData reason(TransferNotificationData.ReasonEnum reason)
-
getReason
public TransferNotificationData.ReasonEnum getReason()
Additional information about the status of the transfer.- Returns:
- reason
-
setReason
public void setReason(TransferNotificationData.ReasonEnum reason)
-
reference
public TransferNotificationData 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 TransferNotificationData 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 TransferNotificationData relayedAuthorisationData(RelayedAuthorisationData relayedAuthorisationData)
-
getRelayedAuthorisationData
public RelayedAuthorisationData getRelayedAuthorisationData()
Get relayedAuthorisationData- Returns:
- relayedAuthorisationData
-
setRelayedAuthorisationData
public void setRelayedAuthorisationData(RelayedAuthorisationData relayedAuthorisationData)
-
sequenceNumber
public TransferNotificationData 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 TransferNotificationData status(TransferNotificationData.StatusEnum status)
-
getStatus
public TransferNotificationData.StatusEnum getStatus()
The result of the transfer. For example, **authorised**, **refused**, or **error**.- Returns:
- status
-
setStatus
public void setStatus(TransferNotificationData.StatusEnum status)
-
tracking
public TransferNotificationData tracking(TransferNotificationTransferTracking tracking)
-
getTracking
public TransferNotificationTransferTracking getTracking()
Get tracking- Returns:
- tracking
-
setTracking
public void setTracking(TransferNotificationTransferTracking tracking)
-
transactionId
@Deprecated public TransferNotificationData transactionId(String transactionId)
Deprecated.
-
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 TransferNotificationData transactionRulesResult(TransactionRulesResult transactionRulesResult)
-
getTransactionRulesResult
public TransactionRulesResult getTransactionRulesResult()
Get transactionRulesResult- Returns:
- transactionRulesResult
-
setTransactionRulesResult
public void setTransactionRulesResult(TransactionRulesResult transactionRulesResult)
-
type
public TransferNotificationData type(TransferNotificationData.TypeEnum type)
-
getType
public TransferNotificationData.TypeEnum getType()
The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**.- Returns:
- type
-
setType
public void setType(TransferNotificationData.TypeEnum type)
-
validationFacts
@Deprecated public TransferNotificationData validationFacts(List<TransferNotificationValidationFact> validationFacts)
Deprecated.
-
addValidationFactsItem
public TransferNotificationData 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.
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOExceptionValidates the JSON Object and throws an exception if issues found- Parameters:
jsonObj- JSON Object- Throws:
IOException- if the JSON Object is invalid with respect to TransferNotificationData
-
fromJson
public static TransferNotificationData fromJson(String jsonString) throws IOException
Create an instance of TransferNotificationData given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of TransferNotificationData
- Throws:
IOException- if the JSON string is invalid with respect to TransferNotificationData
-
toJson
public String toJson()
Convert an instance of TransferNotificationData to an JSON string- Returns:
- JSON string
-
-