Constructor Detail

Method Detail

• body

   final TransactionSimulateAuthorizationParams.Builder body(TransactionSimulateAuthorizationParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • amount

  • descriptor

  • pan

  • mcc

  • merchantAcceptorId

  • etc.

• amount

   final TransactionSimulateAuthorizationParams.Builder amount(Long amount)

  Amount (in cents) to authorize. For credit authorizations and financial credit authorizations, any value entered will be converted into a negative amount in the simulated transaction. For example, entering 100 in this field will result in a -100 amount in the transaction. For balance inquiries, this field must be set to 0.

• amount

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

• descriptor

   final TransactionSimulateAuthorizationParams.Builder descriptor(String descriptor)

  Merchant descriptor.

• descriptor

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

• pan

   final TransactionSimulateAuthorizationParams.Builder pan(String pan)

  Sixteen digit card number.

• pan

   final TransactionSimulateAuthorizationParams.Builder pan(JsonField<String> pan)

  Sets Builder.pan to an arbitrary JSON value.

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

• mcc

   final TransactionSimulateAuthorizationParams.Builder mcc(String mcc)

  Merchant category code for the transaction to be simulated. A four-digit number listed in ISO 18245. Supported merchant category codes can be found here.

• mcc

   final TransactionSimulateAuthorizationParams.Builder mcc(JsonField<String> mcc)

  Sets Builder.mcc to an arbitrary JSON value.

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

• merchantAcceptorId

   final TransactionSimulateAuthorizationParams.Builder merchantAcceptorId(String merchantAcceptorId)

  Unique identifier to identify the payment card acceptor.

• merchantAcceptorId

   final TransactionSimulateAuthorizationParams.Builder merchantAcceptorId(JsonField<String> merchantAcceptorId)

  Sets Builder.merchantAcceptorId to an arbitrary JSON value.

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

• merchantAmount

   final TransactionSimulateAuthorizationParams.Builder merchantAmount(Long merchantAmount)

  Amount of the transaction to be simulated in currency specified in merchant_currency, including any acquirer fees.

• merchantAmount

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

• merchantCurrency

   final TransactionSimulateAuthorizationParams.Builder merchantCurrency(String merchantCurrency)

  3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD, GBP, EUR and defaults to GBP if another ISO 4217 code is provided

• merchantCurrency

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

• partialApprovalCapable

   final TransactionSimulateAuthorizationParams.Builder partialApprovalCapable(Boolean partialApprovalCapable)

  Set to true if the terminal is capable of partial approval otherwise false. Partial approval is when part of a transaction is approved and another payment must be used for the remainder.

• partialApprovalCapable

   final TransactionSimulateAuthorizationParams.Builder partialApprovalCapable(JsonField<Boolean> partialApprovalCapable)

  Sets Builder.partialApprovalCapable to an arbitrary JSON value.

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

• pin

   final TransactionSimulateAuthorizationParams.Builder pin(String pin)

  Simulate entering a PIN. If omitted, PIN check will not be performed.

• pin

   final TransactionSimulateAuthorizationParams.Builder pin(JsonField<String> pin)

  Sets Builder.pin to an arbitrary JSON value.

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

• status

   final TransactionSimulateAuthorizationParams.Builder status(TransactionSimulateAuthorizationParams.Status status)

  Type of event to simulate.

  • AUTHORIZATION is a dual message purchase authorization, meaning a subsequent clearing step is required to settle the transaction.

  • BALANCE_INQUIRY is a $0 authorization requesting the balance held on the card, and is most often observed when a cardholder requests to view a card's balance at an ATM.

  • CREDIT_AUTHORIZATION is a dual message request from a merchant to authorize a refund, meaning a subsequent clearing step is required to settle the transaction.

  • FINANCIAL_AUTHORIZATION is a single message request from a merchant to debit funds immediately (such as an ATM withdrawal), and no subsequent clearing is required to settle the transaction.

  • FINANCIAL_CREDIT_AUTHORIZATION is a single message request from a merchant to credit funds immediately, and no subsequent clearing is required to settle the transaction.

• status

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

• additionalBodyProperties

   final TransactionSimulateAuthorizationParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final TransactionSimulateAuthorizationParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final TransactionSimulateAuthorizationParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final TransactionSimulateAuthorizationParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final TransactionSimulateAuthorizationParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final TransactionSimulateAuthorizationParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final TransactionSimulateAuthorizationParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final TransactionSimulateAuthorizationParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final TransactionSimulateAuthorizationParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final TransactionSimulateAuthorizationParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final TransactionSimulateAuthorizationParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final TransactionSimulateAuthorizationParams build()

  Returns an immutable instance of TransactionSimulateAuthorizationParams.

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

  The following fields are required:

  .amount()
  .descriptor()
  .pan()