Class FinancialTransaction
-
- All Implemented Interfaces:
public final class FinancialTransaction
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFinancialTransaction.BuilderA builder for FinancialTransaction.
public final classFinancialTransaction.CategoryStatus types:
CARD- Issuing card transaction.ACH- Transaction over ACH.INTERNAL- Transaction for internal adjustment.TRANSFER- Internal transfer of funds between financial accounts in your program.
public final classFinancialTransaction.FinancialEventFinancial Event
public final classFinancialTransaction.ResultAPPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.
public final classFinancialTransaction.StatusStatus types:
DECLINED- The transaction was declined.EXPIRED- The authorization as it has passed its expiration time. Card transaction only.PENDING- The transaction is expected to settle.RETURNED- The transaction has been returned.SETTLED- The transaction is completed.VOIDED- The transaction was voided. Card transaction only.
-
Method Summary
Modifier and Type Method Description final Stringtoken()Globally unique identifier. final FinancialTransaction.Categorycategory()Status types: CARD- Issuing card transaction.ACH- Transaction over ACH.INTERNAL- Transaction for internal adjustment.TRANSFER- Internal transfer of funds between financial accounts in your program.
final OffsetDateTimecreated()Date and time when the financial transaction first occurred. final Stringcurrency()3-character alphabetic ISO 4217 code for the settling currency of the transaction. final Stringdescriptor()A string that provides a description of the financial transaction; may be useful to display to users. final List<FinancialTransaction.FinancialEvent>events()A list of all financial events that have modified this financial transaction. final LongpendingAmount()Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. final FinancialTransaction.Resultresult()APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network. final LongsettledAmount()Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents), including any acquirer fees. final FinancialTransaction.Statusstatus()Status types: DECLINED- The transaction was declined.EXPIRED- The authorization as it has passed its expiration time. Card transaction only.PENDING- The transaction is expected to settle.RETURNED- The transaction has been returned.SETTLED- The transaction is completed.VOIDED- The transaction was voided. Card transaction only.
final OffsetDateTimeupdated()Date and time when the financial transaction was last updated. final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<FinancialTransaction.Category>_category()Returns the raw JSON value of category. final JsonField<OffsetDateTime>_created()Returns the raw JSON value of created. final JsonField<String>_currency()Returns the raw JSON value of currency. final JsonField<String>_descriptor()Returns the raw JSON value of descriptor. final JsonField<List<FinancialTransaction.FinancialEvent>>_events()Returns the raw JSON value of events. final JsonField<Long>_pendingAmount()Returns the raw JSON value of pendingAmount. final JsonField<FinancialTransaction.Result>_result()Returns the raw JSON value of result. final JsonField<Long>_settledAmount()Returns the raw JSON value of settledAmount. final JsonField<FinancialTransaction.Status>_status()Returns the raw JSON value of status. final JsonField<OffsetDateTime>_updated()Returns the raw JSON value of updated. final Map<String, JsonValue>_additionalProperties()final FinancialTransaction.BuildertoBuilder()final FinancialTransactionvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FinancialTransaction.Builderbuilder()Returns a mutable builder for constructing an instance of FinancialTransaction. -
-
Method Detail
-
category
final FinancialTransaction.Category category()
Status types:
CARD- Issuing card transaction.ACH- Transaction over ACH.INTERNAL- Transaction for internal adjustment.TRANSFER- Internal transfer of funds between financial accounts in your program.
-
created
final OffsetDateTime created()
Date and time when the financial transaction first occurred. UTC time zone.
-
currency
final String currency()
3-character alphabetic ISO 4217 code for the settling currency of the transaction.
-
descriptor
final String descriptor()
A string that provides a description of the financial transaction; may be useful to display to users.
-
events
final List<FinancialTransaction.FinancialEvent> events()
A list of all financial events that have modified this financial transaction.
-
pendingAmount
final Long pendingAmount()
Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. The value of this field will go to zero over time once the financial transaction is settled.
-
result
final FinancialTransaction.Result result()
APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.
-
settledAmount
final Long settledAmount()
Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents), including any acquirer fees. This may change over time.
-
status
final FinancialTransaction.Status status()
Status types:
DECLINED- The transaction was declined.EXPIRED- The authorization as it has passed its expiration time. Card transaction only.PENDING- The transaction is expected to settle.RETURNED- The transaction has been returned.SETTLED- The transaction is completed.VOIDED- The transaction was voided. Card transaction only.
-
updated
final OffsetDateTime updated()
Date and time when the financial transaction was last updated. UTC time zone.
-
_token
final JsonField<String> _token()
Returns the raw JSON value of token.
Unlike token, this method doesn't throw if the JSON field has an unexpected type.
-
_category
final JsonField<FinancialTransaction.Category> _category()
Returns the raw JSON value of category.
Unlike category, this method doesn't throw if the JSON field has an unexpected type.
-
_created
final JsonField<OffsetDateTime> _created()
Returns the raw JSON value of created.
Unlike created, this method doesn't throw if the JSON field has an unexpected type.
-
_currency
final JsonField<String> _currency()
Returns the raw JSON value of currency.
Unlike currency, this method doesn't throw if the JSON field has an unexpected type.
-
_descriptor
final JsonField<String> _descriptor()
Returns the raw JSON value of descriptor.
Unlike descriptor, this method doesn't throw if the JSON field has an unexpected type.
-
_events
final JsonField<List<FinancialTransaction.FinancialEvent>> _events()
Returns the raw JSON value of events.
Unlike events, this method doesn't throw if the JSON field has an unexpected type.
-
_pendingAmount
final JsonField<Long> _pendingAmount()
Returns the raw JSON value of pendingAmount.
Unlike pendingAmount, this method doesn't throw if the JSON field has an unexpected type.
-
_result
final JsonField<FinancialTransaction.Result> _result()
Returns the raw JSON value of result.
Unlike result, this method doesn't throw if the JSON field has an unexpected type.
-
_settledAmount
final JsonField<Long> _settledAmount()
Returns the raw JSON value of settledAmount.
Unlike settledAmount, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<FinancialTransaction.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_updated
final JsonField<OffsetDateTime> _updated()
Returns the raw JSON value of updated.
Unlike updated, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FinancialTransaction.Builder toBuilder()
-
validate
final FinancialTransaction validate()
-
builder
final static FinancialTransaction.Builder builder()
Returns a mutable builder for constructing an instance of FinancialTransaction.
The following fields are required:
.token() .category() .created() .currency() .descriptor() .events() .pendingAmount() .result() .settledAmount() .status() .updated()
-
-
-