public class Transaction extends Object
| Constructor and Description |
|---|
Transaction() |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
String |
getAcceptHeader()
The 'Accept' header of the customer's web browser.
|
String |
getAcceptLanguageHeader()
The 'Accept Language' header of the customer's web browser.
|
List<Long> |
getAllowedPaymentMethodBrands()
The payment method brands that can be used to authorize the transaction.
|
List<Long> |
getAllowedPaymentMethodConfigurations()
The payment method configurations that can be used to authorize the transaction.
|
BigDecimal |
getAuthorizationAmount()
The sum of all line item prices including taxes in the transaction's currency.
|
ChargeAttemptEnvironment |
getAuthorizationEnvironment()
The environment in which the transaction was authorized.
|
Long |
getAuthorizationSalesChannel()
The sales channel through which the transaction was placed.
|
OffsetDateTime |
getAuthorizationTimeoutOn()
The date and time when the transaction must be authorized, otherwise it will canceled.
|
OffsetDateTime |
getAuthorizedOn()
The date and time when the transaction was authorized.
|
Address |
getBillingAddress()
The address associated with the payment method for invoicing and transaction processing purposes.
|
BigDecimal |
getCompletedAmount()
The total amount that was completed, in the transaction's currency.
|
OffsetDateTime |
getCompletedOn()
The date and time when the transaction was completed.
|
TransactionCompletionBehavior |
getCompletionBehavior()
The behavior that controls when the transaction is completed.
|
OffsetDateTime |
getCompletionTimeoutOn()
The date and time when the transaction is completed automatically.
|
Long |
getConfirmedBy()
The ID of the user the transaction was confirmed by.
|
OffsetDateTime |
getConfirmedOn()
The date and time when the transaction was created.
|
Long |
getCreatedBy()
The ID of the user the transaction was created by.
|
OffsetDateTime |
getCreatedOn()
The date and time when the object was created.
|
String |
getCurrency()
The three-letter code (ISO 4217 format) of the transaction's currency.
|
String |
getCustomerEmailAddress()
The customer's email address.
|
String |
getCustomerId()
The unique identifier of the customer in the external system.
|
CustomersPresence |
getCustomersPresence()
The customer's presence indicates whether and in what way the transaction's customer is present.
|
OffsetDateTime |
getDeliveryDecisionMadeOn()
This date and time when the decision was made as to whether the order should be shipped.
|
String |
getDeviceSessionIdentifier()
Allows to link the transaction to the data collected from the customer's device.
|
OffsetDateTime |
getEndOfLife()
The date and time when the transaction reaches its end of live.
|
Environment |
getEnvironment() |
TransactionEnvironmentSelectionStrategy |
getEnvironmentSelectionStrategy()
The strategy for determining whether the transaction is to be processed in the test or production environment.
|
OffsetDateTime |
getFailedOn()
The date and time when the transaction failed.
|
String |
getFailedUrl()
The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
|
FailureReason |
getFailureReason()
The reason for the failure of the transaction.
|
TransactionGroup |
getGroup()
The group that the transaction belongs to.
|
Long |
getId()
A unique identifier for the object.
|
String |
getInternetProtocolAddress()
The IP address of the customer's device.
|
String |
getInternetProtocolAddressCountry()
The country determined from the IP address of the customer's device.
|
String |
getInvoiceMerchantReference()
The merchant's reference used to identify the invoice.
|
String |
getLanguage()
The language that is linked to the object.
|
List<LineItem> |
getLineItems()
The line items purchased by the customer.
|
Long |
getLinkedSpaceId()
The ID of the space this object belongs to.
|
String |
getMerchantReference()
The merchant's reference used to identify the transaction.
|
Map<String,String> |
getMetaData()
Allow to store additional information about the object.
|
Long |
getParent()
The parent transaction which was (partially) replaced by this transaction.
|
PaymentConnectorConfiguration |
getPaymentConnectorConfiguration()
The payment connector configuration that was used to authorize the transaction.
|
OffsetDateTime |
getPlannedPurgeDate()
The date and time when the object is planned to be permanently removed.
|
OffsetDateTime |
getProcessingOn()
The date and time when the processing of the transaction was started.
|
BigDecimal |
getRefundedAmount()
The total amount that was refunded, in the transaction's currency.
|
String |
getScreenColorDepth()
The screen color depth of the customer's web browser.
|
String |
getScreenHeight()
The screen height of the customer's web browser.
|
String |
getScreenWidth()
The screen width of the customer's web browser.
|
Address |
getShippingAddress()
The address to where the order will be shipped.
|
String |
getShippingMethod()
The name of the shipping method used to ship the products.
|
Long |
getSpaceViewId()
The ID of the space view this object is linked to.
|
TransactionState |
getState()
The object's current state.
|
String |
getSuccessUrl()
The URL to redirect the customer back to after they successfully authenticated their payment.
|
PaymentTerminal |
getTerminal()
The payment terminal through which the payment was processed.
|
String |
getTimeZone()
The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
|
Token |
getToken()
The payment token that should be used to charge the customer.
|
TokenizationMode |
getTokenizationMode()
The tokenization mode specifies whether and how the tokenization of payment information is applied to the transaction.
|
BigDecimal |
getTotalAppliedFees()
The total of all fees charged, in the transaction's currency.
|
BigDecimal |
getTotalSettledAmount()
The total amount that was settled, in the transaction's currency.
|
String |
getUserAgentHeader()
The 'User Agent' header of the customer's web browser.
|
String |
getUserFailureMessage()
The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.
|
TransactionUserInterfaceType |
getUserInterfaceType()
The type of user interface the customer used to provide the payment information.
|
Integer |
getVersion()
The version is used for optimistic locking and incremented whenever the object is updated.
|
String |
getWindowHeight()
The window height of the customer's web browser.
|
String |
getWindowWidth()
The window width of the customer's web browser.
|
Integer |
getYearsToKeep()
The number of years the transaction is kept after its authorization.
|
int |
hashCode() |
Boolean |
isAutoConfirmationEnabled()
Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API.
|
Boolean |
isChargeRetryEnabled()
Whether the customer can make further payment attempts if the first one has failed.
|
Boolean |
isEmailsDisabled()
Whether email sending is deactivated for the transaction.
|
Boolean |
isJavaEnabled()
Whether Java is enabled on the customer's web browser.
|
String |
toString() |
protected String acceptHeader
protected String acceptLanguageHeader
protected BigDecimal authorizationAmount
protected ChargeAttemptEnvironment authorizationEnvironment
protected Long authorizationSalesChannel
protected OffsetDateTime authorizationTimeoutOn
protected OffsetDateTime authorizedOn
protected Boolean autoConfirmationEnabled
protected Address billingAddress
protected Boolean chargeRetryEnabled
protected BigDecimal completedAmount
protected OffsetDateTime completedOn
protected TransactionCompletionBehavior completionBehavior
protected OffsetDateTime completionTimeoutOn
protected Long confirmedBy
protected OffsetDateTime confirmedOn
protected Long createdBy
protected OffsetDateTime createdOn
protected String currency
protected String customerEmailAddress
protected String customerId
protected CustomersPresence customersPresence
protected OffsetDateTime deliveryDecisionMadeOn
protected String deviceSessionIdentifier
protected Boolean emailsDisabled
protected OffsetDateTime endOfLife
protected Environment environment
protected TransactionEnvironmentSelectionStrategy environmentSelectionStrategy
protected OffsetDateTime failedOn
protected String failedUrl
protected FailureReason failureReason
protected TransactionGroup group
protected Long id
protected String internetProtocolAddress
protected String internetProtocolAddressCountry
protected String invoiceMerchantReference
protected Boolean javaEnabled
protected String language
protected Long linkedSpaceId
protected String merchantReference
protected Long parent
protected PaymentConnectorConfiguration paymentConnectorConfiguration
protected OffsetDateTime plannedPurgeDate
protected OffsetDateTime processingOn
protected BigDecimal refundedAmount
protected String screenColorDepth
protected String screenHeight
protected String screenWidth
protected Address shippingAddress
protected String shippingMethod
protected Long spaceViewId
protected TransactionState state
protected String successUrl
protected PaymentTerminal terminal
protected String timeZone
protected Token token
protected TokenizationMode tokenizationMode
protected BigDecimal totalAppliedFees
protected BigDecimal totalSettledAmount
protected String userAgentHeader
protected String userFailureMessage
protected TransactionUserInterfaceType userInterfaceType
protected Integer version
protected String windowHeight
protected String windowWidth
protected Integer yearsToKeep
public String getAcceptHeader()
public String getAcceptLanguageHeader()
public List<Long> getAllowedPaymentMethodBrands()
public List<Long> getAllowedPaymentMethodConfigurations()
public BigDecimal getAuthorizationAmount()
public ChargeAttemptEnvironment getAuthorizationEnvironment()
public Long getAuthorizationSalesChannel()
public OffsetDateTime getAuthorizationTimeoutOn()
public OffsetDateTime getAuthorizedOn()
public Boolean isAutoConfirmationEnabled()
public Address getBillingAddress()
public Boolean isChargeRetryEnabled()
public BigDecimal getCompletedAmount()
public OffsetDateTime getCompletedOn()
public TransactionCompletionBehavior getCompletionBehavior()
public OffsetDateTime getCompletionTimeoutOn()
public Long getConfirmedBy()
public OffsetDateTime getConfirmedOn()
public Long getCreatedBy()
public OffsetDateTime getCreatedOn()
public String getCurrency()
public String getCustomerEmailAddress()
public String getCustomerId()
public CustomersPresence getCustomersPresence()
public OffsetDateTime getDeliveryDecisionMadeOn()
public String getDeviceSessionIdentifier()
public Boolean isEmailsDisabled()
public OffsetDateTime getEndOfLife()
public Environment getEnvironment()
public TransactionEnvironmentSelectionStrategy getEnvironmentSelectionStrategy()
public OffsetDateTime getFailedOn()
public String getFailedUrl()
public FailureReason getFailureReason()
public TransactionGroup getGroup()
public Long getId()
public String getInternetProtocolAddress()
public String getInternetProtocolAddressCountry()
public String getInvoiceMerchantReference()
public Boolean isJavaEnabled()
public String getLanguage()
public List<LineItem> getLineItems()
public Long getLinkedSpaceId()
public String getMerchantReference()
public Map<String,String> getMetaData()
public Long getParent()
public PaymentConnectorConfiguration getPaymentConnectorConfiguration()
public OffsetDateTime getPlannedPurgeDate()
public OffsetDateTime getProcessingOn()
public BigDecimal getRefundedAmount()
public String getScreenColorDepth()
public String getScreenHeight()
public String getScreenWidth()
public Address getShippingAddress()
public String getShippingMethod()
public Long getSpaceViewId()
public TransactionState getState()
public String getSuccessUrl()
public PaymentTerminal getTerminal()
public String getTimeZone()
public Token getToken()
public TokenizationMode getTokenizationMode()
public BigDecimal getTotalAppliedFees()
public BigDecimal getTotalSettledAmount()
public String getUserAgentHeader()
public String getUserFailureMessage()
public TransactionUserInterfaceType getUserInterfaceType()
public Integer getVersion()
public String getWindowHeight()
public String getWindowWidth()
public Integer getYearsToKeep()
Copyright © 2024. All rights reserved.