ChargeAttempt (postfinancecheckout-java-sdk 4.0.2 API)

java.lang.Object
- ch.postfinance.sdk.model.TransactionAwareEntity
- - ch.postfinance.sdk.model.ChargeAttempt

public class ChargeAttempt
extends TransactionAwareEntity

Field Summary

Fields
Modifier and Type	Field and Description
`protected Charge`	`charge`
`protected TransactionCompletionBehavior`	`completionBehavior`
`protected PaymentConnectorConfiguration`	`connectorConfiguration`
`protected OffsetDateTime`	`createdOn`
`protected ChargeAttemptEnvironment`	`environment`
`protected OffsetDateTime`	`failedOn`
`protected FailureReason`	`failureReason`
`protected Boolean`	`initializingTokenVersion`
`protected ConnectorInvocation`	`invocation`
`protected List<Label>`	`labels`
`protected String`	`language`
`protected OffsetDateTime`	`nextUpdateOn`
`protected OffsetDateTime`	`plannedPurgeDate`
`protected String`	`redirectionUrl`
`protected Long`	`salesChannel`
`protected Long`	`spaceViewId`
`protected ChargeAttemptState`	`state`
`protected OffsetDateTime`	`succeededOn`
`protected PaymentTerminal`	`terminal`
`protected OffsetDateTime`	`timeoutOn`
`protected String`	`timeZone`
`protected TokenVersion`	`tokenVersion`
`protected String`	`userFailureMessage`
`protected Integer`	`version`

Fields inherited from class ch.postfinance.sdk.model.TransactionAwareEntity
id, linkedSpaceId, linkedTransaction

Constructor Summary

Constructors
Constructor and Description

ChargeAttempt()

Constructors
Constructor and Description
`ChargeAttempt()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Charge`	`getCharge()`
`TransactionCompletionBehavior`	`getCompletionBehavior()`
`PaymentConnectorConfiguration`	`getConnectorConfiguration()`
`OffsetDateTime`	`getCreatedOn()` The created on date indicates the date on which the entity was stored into the database.
`ChargeAttemptEnvironment`	`getEnvironment()`
`OffsetDateTime`	`getFailedOn()`
`FailureReason`	`getFailureReason()`
`ConnectorInvocation`	`getInvocation()`
`List<Label>`	`getLabels()`
`String`	`getLanguage()`
`OffsetDateTime`	`getNextUpdateOn()`
`OffsetDateTime`	`getPlannedPurgeDate()` The planned purge date indicates when the entity is permanently removed.
`String`	`getRedirectionUrl()`
`Long`	`getSalesChannel()`
`Long`	`getSpaceViewId()`
`ChargeAttemptState`	`getState()`
`OffsetDateTime`	`getSucceededOn()`
`PaymentTerminal`	`getTerminal()`
`OffsetDateTime`	`getTimeoutOn()`
`String`	`getTimeZone()`
`TokenVersion`	`getTokenVersion()`
`String`	`getUserFailureMessage()` The user failure message contains the message for the user in case the attempt failed.
`Integer`	`getVersion()` The version number indicates the version of the entity.
`int`	`hashCode()`
`Boolean`	`isInitializingTokenVersion()`
`String`	`toString()`

Methods inherited from class ch.postfinance.sdk.model.TransactionAwareEntity
getId, getLinkedSpaceId, getLinkedTransaction

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

charge
```
protected Charge charge
```

completionBehavior

protected TransactionCompletionBehavior completionBehavior

connectorConfiguration

protected PaymentConnectorConfiguration connectorConfiguration

createdOn
```
protected OffsetDateTime createdOn
```

environment

protected ChargeAttemptEnvironment environment

failedOn
```
protected OffsetDateTime failedOn
```

failureReason
```
protected FailureReason failureReason
```

initializingTokenVersion

protected Boolean initializingTokenVersion

invocation

protected ConnectorInvocation invocation

labels
```
protected List<Label> labels
```

language
```
protected String language
```

nextUpdateOn
```
protected OffsetDateTime nextUpdateOn
```

plannedPurgeDate

protected OffsetDateTime plannedPurgeDate

redirectionUrl
```
protected String redirectionUrl
```

salesChannel
```
protected Long salesChannel
```

spaceViewId
```
protected Long spaceViewId
```

state
```
protected ChargeAttemptState state
```

succeededOn
```
protected OffsetDateTime succeededOn
```

terminal
```
protected PaymentTerminal terminal
```

timeZone
```
protected String timeZone
```

timeoutOn
```
protected OffsetDateTime timeoutOn
```

tokenVersion
```
protected TokenVersion tokenVersion
```

userFailureMessage
```
protected String userFailureMessage
```

version
```
protected Integer version
```

Constructor Detail
- ChargeAttempt
```
public ChargeAttempt()
```

Method Detail
- getCharge
```
public Charge getCharge()
```
  Returns:
  
  charge
- getCompletionBehavior
```
public TransactionCompletionBehavior getCompletionBehavior()
```
  Returns:
  
  completionBehavior
- getConnectorConfiguration
```
public PaymentConnectorConfiguration getConnectorConfiguration()
```
  Returns:
  
  connectorConfiguration
- getCreatedOn
```
public OffsetDateTime getCreatedOn()
```
  The created on date indicates the date on which the entity was stored into the database.
  
  Returns:
  
  createdOn
- getEnvironment
```
public ChargeAttemptEnvironment getEnvironment()
```
  Returns:
  
  environment
- getFailedOn
```
public OffsetDateTime getFailedOn()
```
  Returns:
  
  failedOn
- getFailureReason
```
public FailureReason getFailureReason()
```
  Returns:
  
  failureReason
- isInitializingTokenVersion
```
public Boolean isInitializingTokenVersion()
```
  Returns:
  
  initializingTokenVersion
- getInvocation
```
public ConnectorInvocation getInvocation()
```
  Returns:
  
  invocation
- getLabels
```
public List<Label> getLabels()
```
  Returns:
  
  labels
- getLanguage
```
public String getLanguage()
```
  Returns:
  
  language
- getNextUpdateOn
```
public OffsetDateTime getNextUpdateOn()
```
  Returns:
  
  nextUpdateOn
- getPlannedPurgeDate
```
public OffsetDateTime getPlannedPurgeDate()
```
  The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.
  
  Returns:
  
  plannedPurgeDate
- getRedirectionUrl
```
public String getRedirectionUrl()
```
  Returns:
  
  redirectionUrl
- getSalesChannel
```
public Long getSalesChannel()
```
  Returns:
  
  salesChannel
- getSpaceViewId
```
public Long getSpaceViewId()
```
  Returns:
  
  spaceViewId
- getState
```
public ChargeAttemptState getState()
```
  Returns:
  
  state
- getSucceededOn
```
public OffsetDateTime getSucceededOn()
```
  Returns:
  
  succeededOn
- getTerminal
```
public PaymentTerminal getTerminal()
```
  Returns:
  
  terminal
- getTimeZone
```
public String getTimeZone()
```
  Returns:
  
  timeZone
- getTimeoutOn
```
public OffsetDateTime getTimeoutOn()
```
  Returns:
  
  timeoutOn
- getTokenVersion
```
public TokenVersion getTokenVersion()
```
  Returns:
  
  tokenVersion
- getUserFailureMessage
```
public String getUserFailureMessage()
```
  The user failure message contains the message for the user in case the attempt failed. The message is localized into the language specified on the transaction.
  
  Returns:
  
  userFailureMessage
- getVersion
```
public Integer getVersion()
```
  The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
  
  Returns:
  
  version
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class TransactionAwareEntity
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class TransactionAwareEntity
- toString
```
public String toString()
```
  Overrides:
  
  toString in class TransactionAwareEntity

Class ChargeAttempt

Field Summary

Fields inherited from class ch.postfinance.sdk.model.TransactionAwareEntity

Constructor Summary

Method Summary

Methods inherited from class ch.postfinance.sdk.model.TransactionAwareEntity

Methods inherited from class java.lang.Object

Field Detail

charge

completionBehavior

connectorConfiguration

createdOn

environment

failedOn

failureReason

initializingTokenVersion

invocation

labels

language

nextUpdateOn

plannedPurgeDate

redirectionUrl

salesChannel

spaceViewId

state

succeededOn

terminal

timeZone

timeoutOn

tokenVersion

userFailureMessage

version

Constructor Detail

ChargeAttempt

Method Detail

getCharge

getCompletionBehavior

getConnectorConfiguration

getCreatedOn

getEnvironment

getFailedOn

getFailureReason

isInitializingTokenVersion

getInvocation

getLabels

getLanguage

getNextUpdateOn

getPlannedPurgeDate

getRedirectionUrl

getSalesChannel

getSpaceViewId

getState

getSucceededOn

getTerminal

getTimeZone

getTimeoutOn

getTokenVersion

getUserFailureMessage

getVersion

equals

hashCode

toString