Class FinancialTransaction.Builder
-
- All Implemented Interfaces:
public final class FinancialTransaction.BuilderA builder for FinancialTransaction.
-
-
Method Summary
Modifier and Type Method Description final FinancialTransaction.Buildertoken(String token)Globally unique identifier. final FinancialTransaction.Buildertoken(JsonField<String> token)Sets Builder.token to an arbitrary JSON value. final FinancialTransaction.Buildercategory(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.
final FinancialTransaction.Buildercategory(JsonField<FinancialTransaction.Category> category)Sets Builder.category to an arbitrary JSON value. final FinancialTransaction.Buildercreated(OffsetDateTime created)Date and time when the financial transaction first occurred. final FinancialTransaction.Buildercreated(JsonField<OffsetDateTime> created)Sets Builder.created to an arbitrary JSON value. final FinancialTransaction.Buildercurrency(String currency)3-character alphabetic ISO 4217 code for the settling currency of the transaction. final FinancialTransaction.Buildercurrency(JsonField<String> currency)Sets Builder.currency to an arbitrary JSON value. final FinancialTransaction.Builderdescriptor(String descriptor)A string that provides a description of the financial transaction; may be useful to display to users. final FinancialTransaction.Builderdescriptor(JsonField<String> descriptor)Sets Builder.descriptor to an arbitrary JSON value. final FinancialTransaction.Builderevents(List<FinancialTransaction.FinancialEvent> events)A list of all financial events that have modified this financial transaction. final FinancialTransaction.Builderevents(JsonField<List<FinancialTransaction.FinancialEvent>> events)Sets Builder.events to an arbitrary JSON value. final FinancialTransaction.BuilderaddEvent(FinancialTransaction.FinancialEvent event)Adds a single FinancialEvent to events. final FinancialTransaction.BuilderpendingAmount(Long pendingAmount)Pending amount of the transaction in the currency's smallest unit (e.g., cents), including any acquirer fees. final FinancialTransaction.BuilderpendingAmount(JsonField<Long> pendingAmount)Sets Builder.pendingAmount to an arbitrary JSON value. final FinancialTransaction.Builderresult(FinancialTransaction.Result result)APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network. final FinancialTransaction.Builderresult(JsonField<FinancialTransaction.Result> result)Sets Builder.result to an arbitrary JSON value. final FinancialTransaction.BuildersettledAmount(Long settledAmount)Amount of the transaction that has been settled in the currency's smallest unit (e.g., cents), including any acquirer fees. final FinancialTransaction.BuildersettledAmount(JsonField<Long> settledAmount)Sets Builder.settledAmount to an arbitrary JSON value. final FinancialTransaction.Builderstatus(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.
final FinancialTransaction.Builderstatus(JsonField<FinancialTransaction.Status> status)Sets Builder.status to an arbitrary JSON value. final FinancialTransaction.Builderupdated(OffsetDateTime updated)Date and time when the financial transaction was last updated. final FinancialTransaction.Builderupdated(JsonField<OffsetDateTime> updated)Sets Builder.updated to an arbitrary JSON value. final FinancialTransaction.BuilderadditionalProperties(Map<String, JsonValue> additionalProperties)final FinancialTransaction.BuilderputAdditionalProperty(String key, JsonValue value)final FinancialTransaction.BuilderputAllAdditionalProperties(Map<String, JsonValue> additionalProperties)final FinancialTransaction.BuilderremoveAdditionalProperty(String key)final FinancialTransaction.BuilderremoveAllAdditionalProperties(Set<String> keys)final FinancialTransactionbuild()Returns an immutable instance of FinancialTransaction. -
-
Method Detail
-
token
final FinancialTransaction.Builder token(String token)
Globally unique identifier.
-
token
final FinancialTransaction.Builder token(JsonField<String> token)
Sets Builder.token to an arbitrary JSON value.
You should usually call Builder.token with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
category
final FinancialTransaction.Builder category(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.
-
category
final FinancialTransaction.Builder category(JsonField<FinancialTransaction.Category> category)
Sets Builder.category to an arbitrary JSON value.
You should usually call Builder.category with a well-typed Category value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
created
final FinancialTransaction.Builder created(OffsetDateTime created)
Date and time when the financial transaction first occurred. UTC time zone.
-
created
final FinancialTransaction.Builder created(JsonField<OffsetDateTime> created)
Sets Builder.created to an arbitrary JSON value.
You should usually call Builder.created with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
currency
final FinancialTransaction.Builder currency(String currency)
3-character alphabetic ISO 4217 code for the settling currency of the transaction.
-
currency
final FinancialTransaction.Builder currency(JsonField<String> currency)
Sets Builder.currency to an arbitrary JSON value.
You should usually call Builder.currency with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
descriptor
final FinancialTransaction.Builder descriptor(String descriptor)
A string that provides a description of the financial transaction; may be useful to display to users.
-
descriptor
final FinancialTransaction.Builder descriptor(JsonField<String> descriptor)
Sets Builder.descriptor to an arbitrary JSON value.
You should usually call Builder.descriptor with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
events
final FinancialTransaction.Builder events(List<FinancialTransaction.FinancialEvent> events)
A list of all financial events that have modified this financial transaction.
-
events
final FinancialTransaction.Builder events(JsonField<List<FinancialTransaction.FinancialEvent>> events)
Sets Builder.events to an arbitrary JSON value.
You should usually call Builder.events with a well-typed
List<FinancialEvent>value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addEvent
final FinancialTransaction.Builder addEvent(FinancialTransaction.FinancialEvent event)
Adds a single FinancialEvent to events.
-
pendingAmount
final FinancialTransaction.Builder pendingAmount(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.
-
pendingAmount
final FinancialTransaction.Builder pendingAmount(JsonField<Long> pendingAmount)
Sets Builder.pendingAmount to an arbitrary JSON value.
You should usually call Builder.pendingAmount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
result
final FinancialTransaction.Builder result(FinancialTransaction.Result result)
APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.
-
result
final FinancialTransaction.Builder result(JsonField<FinancialTransaction.Result> result)
Sets Builder.result to an arbitrary JSON value.
You should usually call Builder.result with a well-typed Result value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
settledAmount
final FinancialTransaction.Builder settledAmount(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.
-
settledAmount
final FinancialTransaction.Builder settledAmount(JsonField<Long> settledAmount)
Sets Builder.settledAmount to an arbitrary JSON value.
You should usually call Builder.settledAmount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
status
final FinancialTransaction.Builder status(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.
-
status
final FinancialTransaction.Builder status(JsonField<FinancialTransaction.Status> status)
Sets Builder.status to an arbitrary JSON value.
You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
updated
final FinancialTransaction.Builder updated(OffsetDateTime updated)
Date and time when the financial transaction was last updated. UTC time zone.
-
updated
final FinancialTransaction.Builder updated(JsonField<OffsetDateTime> updated)
Sets Builder.updated to an arbitrary JSON value.
You should usually call Builder.updated with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final FinancialTransaction.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final FinancialTransaction.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final FinancialTransaction.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final FinancialTransaction.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final FinancialTransaction.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final FinancialTransaction build()
Returns an immutable instance of FinancialTransaction.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.token() .category() .created() .currency() .descriptor() .events() .pendingAmount() .result() .settledAmount() .status() .updated()
-
-
-