Class Transfer
-
- All Implemented Interfaces:
public final class Transfer
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTransfer.BuilderA builder for Transfer.
public final classTransfer.CategoryStatus types:
TRANSFER- Internal transfer of funds between financial accounts in your program.
public final classTransfer.FinancialEventFinancial Event
public final classTransfer.ResultAPPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.
public final classTransfer.StatusStatus types:
DECLINED- The transfer was declined.EXPIRED- The transfer was held in pending for too long and expired.PENDING- The transfer is pending release from a hold.SETTLED- The transfer is completed.VOIDED- The transfer was reversed before it settled.
-
Method Summary
Modifier and Type Method Description final Optional<String>token()Globally unique identifier for the transfer event. final Optional<Transfer.Category>category()Status types: TRANSFER- Internal transfer of funds between financial accounts in your program.
final Optional<OffsetDateTime>created()Date and time when the transfer occurred. final Optional<String>currency()3-character alphabetic ISO 4217 code for the settling currency of the transaction. final Optional<String>descriptor()A string that provides a description of the transfer; may be useful to display to users. final Optional<List<Transfer.FinancialEvent>>events()A list of all financial events that have modified this trasnfer. final Optional<List<Balance>>fromBalance()The updated balance of the sending financial account. final Optional<Long>pendingAmount()Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. final Optional<Transfer.Result>result()APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network. final Optional<Long>settledAmount()Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents). final Optional<Transfer.Status>status()Status types: DECLINED- The transfer was declined.EXPIRED- The transfer was held in pending for too long and expired.PENDING- The transfer is pending release from a hold.SETTLED- The transfer is completed.VOIDED- The transfer was reversed before it settled.
final Optional<List<Balance>>toBalance()The updated balance of the receiving financial account. final Optional<OffsetDateTime>updated()Date and time when the financial transaction was last updated. final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<Transfer.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<Transfer.FinancialEvent>>_events()Returns the raw JSON value of events. final JsonField<List<Balance>>_fromBalance()Returns the raw JSON value of fromBalance. final JsonField<Long>_pendingAmount()Returns the raw JSON value of pendingAmount. final JsonField<Transfer.Result>_result()Returns the raw JSON value of result. final JsonField<Long>_settledAmount()Returns the raw JSON value of settledAmount. final JsonField<Transfer.Status>_status()Returns the raw JSON value of status. final JsonField<List<Balance>>_toBalance()Returns the raw JSON value of toBalance. final JsonField<OffsetDateTime>_updated()Returns the raw JSON value of updated. final Map<String, JsonValue>_additionalProperties()final Transfer.BuildertoBuilder()final Transfervalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Transfer.Builderbuilder()Returns a mutable builder for constructing an instance of Transfer. -
-
Method Detail
-
category
final Optional<Transfer.Category> category()
Status types:
TRANSFER- Internal transfer of funds between financial accounts in your program.
-
created
final Optional<OffsetDateTime> created()
Date and time when the transfer occurred. UTC time zone.
-
currency
final Optional<String> currency()
3-character alphabetic ISO 4217 code for the settling currency of the transaction.
-
descriptor
final Optional<String> descriptor()
A string that provides a description of the transfer; may be useful to display to users.
-
events
final Optional<List<Transfer.FinancialEvent>> events()
A list of all financial events that have modified this trasnfer.
-
fromBalance
final Optional<List<Balance>> fromBalance()
The updated balance of the sending financial account.
-
pendingAmount
final Optional<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 Optional<Transfer.Result> result()
APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.
-
settledAmount
final Optional<Long> settledAmount()
Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents).
-
status
final Optional<Transfer.Status> status()
Status types:
DECLINED- The transfer was declined.EXPIRED- The transfer was held in pending for too long and expired.PENDING- The transfer is pending release from a hold.SETTLED- The transfer is completed.VOIDED- The transfer was reversed before it settled.
-
toBalance
final Optional<List<Balance>> toBalance()
The updated balance of the receiving financial account.
-
updated
final Optional<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<Transfer.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<Transfer.FinancialEvent>> _events()
Returns the raw JSON value of events.
Unlike events, this method doesn't throw if the JSON field has an unexpected type.
-
_fromBalance
final JsonField<List<Balance>> _fromBalance()
Returns the raw JSON value of fromBalance.
Unlike fromBalance, 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<Transfer.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<Transfer.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_toBalance
final JsonField<List<Balance>> _toBalance()
Returns the raw JSON value of toBalance.
Unlike toBalance, 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 Transfer.Builder toBuilder()
-
builder
final static Transfer.Builder builder()
Returns a mutable builder for constructing an instance of Transfer.
-
-
-