Constructor Detail

Method Detail

• token

   final Transaction.Builder token(String token)

  Globally unique identifier.

• token

   final Transaction.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.

• accountToken

   final Transaction.Builder accountToken(String accountToken)

  The token for the account associated with this transaction.

• accountToken

   final Transaction.Builder accountToken(JsonField<String> accountToken)

  Sets Builder.accountToken to an arbitrary JSON value.

  You should usually call Builder.accountToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• acquirerFee

   final Transaction.Builder acquirerFee(Long acquirerFee)

  Fee assessed by the merchant and paid for by the cardholder in the smallest unit of the currency. Will be zero if no fee is assessed. Rebates may be transmitted as a negative value to indicate credited fees.

• acquirerFee

   final Transaction.Builder acquirerFee(Long acquirerFee)

  Alias for Builder.acquirerFee.

  This unboxed primitive overload exists for backwards compatibility.

• acquirerFee

   final Transaction.Builder acquirerFee(Optional<Long> acquirerFee)

  Alias for calling Builder.acquirerFee with acquirerFee.orElse(null).

• acquirerFee

   final Transaction.Builder acquirerFee(JsonField<Long> acquirerFee)

  Sets Builder.acquirerFee to an arbitrary JSON value.

  You should usually call Builder.acquirerFee with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• acquirerReferenceNumber

  @Deprecated(message = "deprecated") final Transaction.Builder acquirerReferenceNumber(String acquirerReferenceNumber)

  Unique identifier assigned to a transaction by the acquirer that can be used in dispute and chargeback filing. This field has been deprecated in favor of the acquirer_reference_number that resides in the event-level network_info.

• acquirerReferenceNumber

  @Deprecated(message = "deprecated") final Transaction.Builder acquirerReferenceNumber(Optional<String> acquirerReferenceNumber)

  Alias for calling Builder.acquirerReferenceNumber with acquirerReferenceNumber.orElse(null).

• acquirerReferenceNumber

  @Deprecated(message = "deprecated") final Transaction.Builder acquirerReferenceNumber(JsonField<String> acquirerReferenceNumber)

  Sets Builder.acquirerReferenceNumber to an arbitrary JSON value.

  You should usually call Builder.acquirerReferenceNumber with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• amount

  @Deprecated(message = "deprecated") final Transaction.Builder amount(Long amount)

  When the transaction is pending, this represents the authorization amount of the transaction in the anticipated settlement currency. Once the transaction has settled, this field represents the settled amount in the settlement currency.

• amount

  @Deprecated(message = "deprecated") final Transaction.Builder amount(JsonField<Long> amount)

  Sets Builder.amount to an arbitrary JSON value.

  You should usually call Builder.amount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• amounts

   final Transaction.Builder amounts(Transaction.TransactionAmounts amounts)

• amounts

   final Transaction.Builder amounts(JsonField<Transaction.TransactionAmounts> amounts)

  Sets Builder.amounts to an arbitrary JSON value.

  You should usually call Builder.amounts with a well-typed TransactionAmounts value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• authorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder authorizationAmount(Long authorizationAmount)

  The authorization amount of the transaction in the anticipated settlement currency.

• authorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder authorizationAmount(Long authorizationAmount)

  Alias for Builder.authorizationAmount.

  This unboxed primitive overload exists for backwards compatibility.

• authorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder authorizationAmount(Optional<Long> authorizationAmount)

  Alias for calling Builder.authorizationAmount with authorizationAmount.orElse(null).

• authorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder authorizationAmount(JsonField<Long> authorizationAmount)

  Sets Builder.authorizationAmount to an arbitrary JSON value.

  You should usually call Builder.authorizationAmount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• authorizationCode

   final Transaction.Builder authorizationCode(String authorizationCode)

  A fixed-width 6-digit numeric identifier that can be used to identify a transaction with networks.

• authorizationCode

   final Transaction.Builder authorizationCode(Optional<String> authorizationCode)

  Alias for calling Builder.authorizationCode with authorizationCode.orElse(null).

• authorizationCode

   final Transaction.Builder authorizationCode(JsonField<String> authorizationCode)

  Sets Builder.authorizationCode to an arbitrary JSON value.

  You should usually call Builder.authorizationCode with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• avs

   final Transaction.Builder avs(Transaction.Avs avs)

• avs

   final Transaction.Builder avs(Optional<Transaction.Avs> avs)

  Alias for calling Builder.avs with avs.orElse(null).

• avs

   final Transaction.Builder avs(JsonField<Transaction.Avs> avs)

  Sets Builder.avs to an arbitrary JSON value.

  You should usually call Builder.avs with a well-typed Avs value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• cardToken

   final Transaction.Builder cardToken(String cardToken)

  Token for the card used in this transaction.

• cardToken

   final Transaction.Builder cardToken(JsonField<String> cardToken)

  Sets Builder.cardToken to an arbitrary JSON value.

  You should usually call Builder.cardToken with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• cardholderAuthentication

   final Transaction.Builder cardholderAuthentication(Transaction.CardholderAuthentication cardholderAuthentication)

• cardholderAuthentication

   final Transaction.Builder cardholderAuthentication(Optional<Transaction.CardholderAuthentication> cardholderAuthentication)

  Alias for calling Builder.cardholderAuthentication with cardholderAuthentication.orElse(null).

• cardholderAuthentication

   final Transaction.Builder cardholderAuthentication(JsonField<Transaction.CardholderAuthentication> cardholderAuthentication)

  Sets Builder.cardholderAuthentication to an arbitrary JSON value.

  You should usually call Builder.cardholderAuthentication with a well-typed CardholderAuthentication value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• created

   final Transaction.Builder created(OffsetDateTime created)

  Date and time when the transaction first occurred. UTC time zone.

• created

   final Transaction.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.

• merchant

   final Transaction.Builder merchant(Transaction.Merchant merchant)

• merchant

   final Transaction.Builder merchant(JsonField<Transaction.Merchant> merchant)

  Sets Builder.merchant to an arbitrary JSON value.

  You should usually call Builder.merchant with a well-typed Merchant value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• merchantAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAmount(Long merchantAmount)

  Analogous to the 'amount', but in the merchant currency.

• merchantAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAmount(Long merchantAmount)

  Alias for Builder.merchantAmount.

  This unboxed primitive overload exists for backwards compatibility.

• merchantAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAmount(Optional<Long> merchantAmount)

  Alias for calling Builder.merchantAmount with merchantAmount.orElse(null).

• merchantAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAmount(JsonField<Long> merchantAmount)

  Sets Builder.merchantAmount to an arbitrary JSON value.

  You should usually call Builder.merchantAmount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• merchantAuthorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAuthorizationAmount(Long merchantAuthorizationAmount)

  Analogous to the 'authorization_amount', but in the merchant currency.

• merchantAuthorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAuthorizationAmount(Long merchantAuthorizationAmount)

  Alias for Builder.merchantAuthorizationAmount.

  This unboxed primitive overload exists for backwards compatibility.

• merchantAuthorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAuthorizationAmount(Optional<Long> merchantAuthorizationAmount)

  Alias for calling Builder.merchantAuthorizationAmount with merchantAuthorizationAmount.orElse(null).

• merchantAuthorizationAmount

  @Deprecated(message = "deprecated") final Transaction.Builder merchantAuthorizationAmount(JsonField<Long> merchantAuthorizationAmount)

  Sets Builder.merchantAuthorizationAmount to an arbitrary JSON value.

  You should usually call Builder.merchantAuthorizationAmount with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• merchantCurrency

  @Deprecated(message = "deprecated") final Transaction.Builder merchantCurrency(String merchantCurrency)

  3-character alphabetic ISO 4217 code for the local currency of the transaction.

• merchantCurrency

  @Deprecated(message = "deprecated") final Transaction.Builder merchantCurrency(JsonField<String> merchantCurrency)

  Sets Builder.merchantCurrency to an arbitrary JSON value.

  You should usually call Builder.merchantCurrency with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• network

   final Transaction.Builder network(Transaction.Network network)

  Card network of the authorization. Value is UNKNOWN when Lithic cannot determine the network code from the upstream provider.

• network

   final Transaction.Builder network(Optional<Transaction.Network> network)

  Alias for calling Builder.network with network.orElse(null).

• network

   final Transaction.Builder network(JsonField<Transaction.Network> network)

  Sets Builder.network to an arbitrary JSON value.

  You should usually call Builder.network with a well-typed Network value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• networkRiskScore

   final Transaction.Builder networkRiskScore(Long networkRiskScore)

  Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.

• networkRiskScore

   final Transaction.Builder networkRiskScore(Long networkRiskScore)

  Alias for Builder.networkRiskScore.

  This unboxed primitive overload exists for backwards compatibility.

• networkRiskScore

   final Transaction.Builder networkRiskScore(Optional<Long> networkRiskScore)

  Alias for calling Builder.networkRiskScore with networkRiskScore.orElse(null).

• networkRiskScore

   final Transaction.Builder networkRiskScore(JsonField<Long> networkRiskScore)

  Sets Builder.networkRiskScore to an arbitrary JSON value.

  You should usually call Builder.networkRiskScore with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• pos

   final Transaction.Builder pos(Transaction.Pos pos)

• pos

   final Transaction.Builder pos(JsonField<Transaction.Pos> pos)

  Sets Builder.pos to an arbitrary JSON value.

  You should usually call Builder.pos with a well-typed Pos value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• result

   final Transaction.Builder result(Transaction.DeclineResult result)

• result

   final Transaction.Builder result(JsonField<Transaction.DeclineResult> result)

  Sets Builder.result to an arbitrary JSON value.

  You should usually call Builder.result with a well-typed DeclineResult value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• settledAmount

  @Deprecated(message = "deprecated") final Transaction.Builder settledAmount(Long settledAmount)

  The settled amount of the transaction in the settlement currency.

• settledAmount

  @Deprecated(message = "deprecated") final Transaction.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 Transaction.Builder status(Transaction.Status status)

  Status of the transaction.

• status

   final Transaction.Builder status(JsonField<Transaction.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.

• tokenInfo

   final Transaction.Builder tokenInfo(Transaction.TokenInfo tokenInfo)

• tokenInfo

   final Transaction.Builder tokenInfo(Optional<Transaction.TokenInfo> tokenInfo)

  Alias for calling Builder.tokenInfo with tokenInfo.orElse(null).

• tokenInfo

   final Transaction.Builder tokenInfo(JsonField<Transaction.TokenInfo> tokenInfo)

  Sets Builder.tokenInfo to an arbitrary JSON value.

  You should usually call Builder.tokenInfo with a well-typed TokenInfo value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• updated

   final Transaction.Builder updated(OffsetDateTime updated)

  Date and time when the transaction last updated. UTC time zone.

• updated

   final Transaction.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.

• events

   final Transaction.Builder events(List<Transaction.TransactionEvent> events)

• events

   final Transaction.Builder events(JsonField<List<Transaction.TransactionEvent>> events)

  Sets Builder.events to an arbitrary JSON value.

  You should usually call Builder.events with a well-typed List<TransactionEvent> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addEvent

   final Transaction.Builder addEvent(Transaction.TransactionEvent event)

  Adds a single TransactionEvent to events.

• additionalProperties

   final Transaction.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final Transaction.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final Transaction.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final Transaction.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final Transaction.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final Transaction build()

  Returns an immutable instance of Transaction.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .token()
  .accountToken()
  .acquirerFee()
  .acquirerReferenceNumber()
  .amount()
  .amounts()
  .authorizationAmount()
  .authorizationCode()
  .avs()
  .cardToken()
  .cardholderAuthentication()
  .created()
  .merchant()
  .merchantAmount()
  .merchantAuthorizationAmount()
  .merchantCurrency()
  .network()
  .networkRiskScore()
  .pos()
  .result()
  .settledAmount()
  .status()
  .tokenInfo()
  .updated()