Package com.adyen.model.transfers
Class Transaction
- java.lang.Object
-
- com.adyen.model.transfers.Transaction
-
public class Transaction extends Object
Transaction
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTransaction.CategoryEnumThe category of the transaction indicating the type of activity.static classTransaction.StatusEnumThe status of the transaction.static classTransaction.TypeEnumThe type of the transaction.
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_ACCOUNT_HOLDER_IDstatic StringJSON_PROPERTY_AMOUNTstatic StringJSON_PROPERTY_BALANCE_ACCOUNT_IDstatic StringJSON_PROPERTY_BALANCE_PLATFORMstatic StringJSON_PROPERTY_BOOKING_DATEstatic StringJSON_PROPERTY_CATEGORYstatic StringJSON_PROPERTY_COUNTERPARTYstatic StringJSON_PROPERTY_CREATED_ATstatic StringJSON_PROPERTY_DESCRIPTIONstatic StringJSON_PROPERTY_IDstatic StringJSON_PROPERTY_INSTRUCTED_AMOUNTstatic StringJSON_PROPERTY_PAYMENT_INSTRUMENT_IDstatic StringJSON_PROPERTY_REFERENCEstatic StringJSON_PROPERTY_REFERENCE_FOR_BENEFICIARYstatic StringJSON_PROPERTY_STATUSstatic StringJSON_PROPERTY_TRANSFER_IDstatic StringJSON_PROPERTY_TYPEstatic StringJSON_PROPERTY_VALUE_DATE
-
Constructor Summary
Constructors Constructor Description Transaction()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TransactionaccountHolderId(String accountHolderId)Transactionamount(Amount amount)TransactionbalanceAccountId(String balanceAccountId)TransactionbalancePlatform(String balancePlatform)TransactionbookingDate(OffsetDateTime bookingDate)Transactioncategory(Transaction.CategoryEnum category)Transactioncounterparty(CounterpartyV3 counterparty)TransactioncreatedAt(OffsetDateTime createdAt)Transactiondescription(String description)booleanequals(Object o)Return true if this Transaction object is equal to o.static TransactionfromJson(String jsonString)Create an instance of Transaction given an JSON stringStringgetAccountHolderId()Unique identifier of the account holder.AmountgetAmount()Get amountStringgetBalanceAccountId()Unique identifier of the balance account.StringgetBalancePlatform()Unique identifier of the balance platform.OffsetDateTimegetBookingDate()The date the transaction was booked to the balance account.Transaction.CategoryEnumgetCategory()The category of the transaction indicating the type of activity.CounterpartyV3getCounterparty()Get counterpartyOffsetDateTimegetCreatedAt()The date the transaction was created.StringgetDescription()The `description` from the `/transfers` request.StringgetId()Unique identifier of the transaction.AmountgetInstructedAmount()Get instructedAmountStringgetPaymentInstrumentId()Unique identifier of the payment instrument that was used for the transaction.StringgetReference()The [`reference`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__reqParam_reference) from the `/transfers` request.StringgetReferenceForBeneficiary()The reference sent to or received from the counterparty.Transaction.StatusEnumgetStatus()The status of the transaction.StringgetTransferId()Unique identifier of the related transfer.Transaction.TypeEnumgetType()The type of the transaction.OffsetDateTimegetValueDate()The date the transfer amount becomes available in the balance account.inthashCode()Transactionid(String id)TransactioninstructedAmount(Amount instructedAmount)TransactionpaymentInstrumentId(String paymentInstrumentId)Transactionreference(String reference)TransactionreferenceForBeneficiary(String referenceForBeneficiary)voidsetAccountHolderId(String accountHolderId)voidsetAmount(Amount amount)voidsetBalanceAccountId(String balanceAccountId)voidsetBalancePlatform(String balancePlatform)voidsetBookingDate(OffsetDateTime bookingDate)voidsetCategory(Transaction.CategoryEnum category)voidsetCounterparty(CounterpartyV3 counterparty)voidsetCreatedAt(OffsetDateTime createdAt)voidsetDescription(String description)voidsetId(String id)voidsetInstructedAmount(Amount instructedAmount)voidsetPaymentInstrumentId(String paymentInstrumentId)voidsetReference(String reference)voidsetReferenceForBeneficiary(String referenceForBeneficiary)voidsetStatus(Transaction.StatusEnum status)voidsetTransferId(String transferId)voidsetType(Transaction.TypeEnum type)voidsetValueDate(OffsetDateTime valueDate)Transactionstatus(Transaction.StatusEnum status)StringtoJson()Convert an instance of Transaction to an JSON stringStringtoString()TransactiontransferId(String transferId)Transactiontype(Transaction.TypeEnum type)TransactionvalueDate(OffsetDateTime valueDate)
-
-
-
Field Detail
-
JSON_PROPERTY_ACCOUNT_HOLDER_ID
public static final String JSON_PROPERTY_ACCOUNT_HOLDER_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- 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_BOOKING_DATE
public static final String JSON_PROPERTY_BOOKING_DATE
- 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_CREATED_AT
public static final String JSON_PROPERTY_CREATED_AT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DESCRIPTION
public static final String JSON_PROPERTY_DESCRIPTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ID
public static final String JSON_PROPERTY_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_INSTRUCTED_AMOUNT
public static final String JSON_PROPERTY_INSTRUCTED_AMOUNT
- 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_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_STATUS
public static final String JSON_PROPERTY_STATUS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRANSFER_ID
public static final String JSON_PROPERTY_TRANSFER_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_VALUE_DATE
public static final String JSON_PROPERTY_VALUE_DATE
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountHolderId
public Transaction accountHolderId(String accountHolderId)
-
getAccountHolderId
public String getAccountHolderId()
Unique identifier of the account holder.- Returns:
- accountHolderId
-
setAccountHolderId
public void setAccountHolderId(String accountHolderId)
-
amount
public Transaction amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
-
balanceAccountId
public Transaction balanceAccountId(String balanceAccountId)
-
getBalanceAccountId
public String getBalanceAccountId()
Unique identifier of the balance account.- Returns:
- balanceAccountId
-
setBalanceAccountId
public void setBalanceAccountId(String balanceAccountId)
-
balancePlatform
public Transaction balancePlatform(String balancePlatform)
-
getBalancePlatform
public String getBalancePlatform()
Unique identifier of the balance platform.- Returns:
- balancePlatform
-
setBalancePlatform
public void setBalancePlatform(String balancePlatform)
-
bookingDate
public Transaction bookingDate(OffsetDateTime bookingDate)
-
getBookingDate
public OffsetDateTime getBookingDate()
The date the transaction was booked to the balance account.- Returns:
- bookingDate
-
setBookingDate
public void setBookingDate(OffsetDateTime bookingDate)
-
category
public Transaction category(Transaction.CategoryEnum category)
-
getCategory
public Transaction.CategoryEnum getCategory()
The category of the transaction indicating the type of activity. Possible values: * **platformPayment**: The transaction is a payment or payment modification made with an Adyen merchant account. * **internal**: The transaction resulted from an internal adjustment such as a deposit correction or invoice deduction. * **bank**: The transaction is a bank-related activity, such as sending a payout or receiving funds. * **issuedCard**: The transaction is a card-related activity, such as using an Adyen-issued card to pay online.- Returns:
- category
-
setCategory
public void setCategory(Transaction.CategoryEnum category)
-
counterparty
public Transaction counterparty(CounterpartyV3 counterparty)
-
getCounterparty
public CounterpartyV3 getCounterparty()
Get counterparty- Returns:
- counterparty
-
setCounterparty
public void setCounterparty(CounterpartyV3 counterparty)
-
createdAt
public Transaction createdAt(OffsetDateTime createdAt)
-
getCreatedAt
public OffsetDateTime getCreatedAt()
The date the transaction was created.- Returns:
- createdAt
-
setCreatedAt
public void setCreatedAt(OffsetDateTime createdAt)
-
description
public Transaction description(String description)
-
getDescription
public String getDescription()
The `description` from the `/transfers` request.- Returns:
- description
-
setDescription
public void setDescription(String description)
-
id
public Transaction id(String id)
-
getId
public String getId()
Unique identifier of the transaction.- Returns:
- id
-
setId
public void setId(String id)
-
instructedAmount
public Transaction instructedAmount(Amount instructedAmount)
-
getInstructedAmount
public Amount getInstructedAmount()
Get instructedAmount- Returns:
- instructedAmount
-
setInstructedAmount
public void setInstructedAmount(Amount instructedAmount)
-
paymentInstrumentId
public Transaction paymentInstrumentId(String paymentInstrumentId)
-
getPaymentInstrumentId
public String getPaymentInstrumentId()
Unique identifier of the payment instrument that was used for the transaction.- Returns:
- paymentInstrumentId
-
setPaymentInstrumentId
public void setPaymentInstrumentId(String paymentInstrumentId)
-
reference
public Transaction reference(String reference)
-
getReference
public String getReference()
The [`reference`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__reqParam_reference) from the `/transfers` request. If you haven't provided any, Adyen generates a unique reference.- Returns:
- reference
-
setReference
public void setReference(String reference)
-
referenceForBeneficiary
public Transaction referenceForBeneficiary(String referenceForBeneficiary)
-
getReferenceForBeneficiary
public String getReferenceForBeneficiary()
The reference sent to or received from the counterparty. * For outgoing funds, this is the [`referenceForBeneficiary`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__resParam_referenceForBeneficiary) from the [`/transfers`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__reqParam_referenceForBeneficiary) request. * For incoming funds, this is the reference from the sender.- Returns:
- referenceForBeneficiary
-
setReferenceForBeneficiary
public void setReferenceForBeneficiary(String referenceForBeneficiary)
-
status
public Transaction status(Transaction.StatusEnum status)
-
getStatus
public Transaction.StatusEnum getStatus()
The status of the transaction. Possible values: * **pending**: The transaction is still pending. * **booked**: The transaction has been booked to the balance account.- Returns:
- status
-
setStatus
public void setStatus(Transaction.StatusEnum status)
-
transferId
public Transaction transferId(String transferId)
-
getTransferId
public String getTransferId()
Unique identifier of the related transfer.- Returns:
- transferId
-
setTransferId
public void setTransferId(String transferId)
-
type
public Transaction type(Transaction.TypeEnum type)
-
getType
public Transaction.TypeEnum getType()
The type of the transaction. Possible values: **payment**, **capture**, **captureReversal**, **refund** **refundReversal**, **chargeback**, **chargebackReversal**, **secondChargeback**, **atmWithdrawal**, **atmWithdrawalReversal**, **internalTransfer**, **manualCorrection**, **invoiceDeduction**, **depositCorrection**, **bankTransfer**, **miscCost**, **paymentCost**, **fee**- Returns:
- type
-
setType
public void setType(Transaction.TypeEnum type)
-
valueDate
public Transaction valueDate(OffsetDateTime valueDate)
-
getValueDate
public OffsetDateTime getValueDate()
The date the transfer amount becomes available in the balance account.- Returns:
- valueDate
-
setValueDate
public void setValueDate(OffsetDateTime valueDate)
-
equals
public boolean equals(Object o)
Return true if this Transaction object is equal to o.
-
fromJson
public static Transaction fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of Transaction given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of Transaction
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to Transaction
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of Transaction to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-