All Implemented Interfaces:

com.lithic.api.core.Params
```
public final class TransactionSimulateAuthorizationParams
 implements Params
                    
```
Simulates an authorization request from the card network as if it came from a merchant acquirer. If you are configured for ASA, simulating authorizations requires your ASA client to be set up properly, i.e. be able to respond to the ASA request with a valid JSON. For users that are not configured for ASA, a daily transaction limit of $5000 USD is applied by default. You can update this limit via the update account endpoint.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`TransactionSimulateAuthorizationParams.Builder`	A builder for TransactionSimulateAuthorizationParams.
`public final class`	`TransactionSimulateAuthorizationParams.Body`
`public final class`	`TransactionSimulateAuthorizationParams.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.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Long`	`amount()`	Amount (in cents) to authorize.
`final String`	`descriptor()`	Merchant descriptor.
`final String`	`pan()`	Sixteen digit card number.
`final Optional<String>`	`mcc()`	Merchant category code for the transaction to be simulated.
`final Optional<String>`	`merchantAcceptorId()`	Unique identifier to identify the payment card acceptor.
`final Optional<Long>`	`merchantAmount()`	Amount of the transaction to be simulated in currency specified in merchant_currency, including any acquirer fees.
`final Optional<String>`	`merchantCurrency()`	3-character alphabetic ISO 4217 currency code.
`final Optional<Boolean>`	`partialApprovalCapable()`	Set to true if the terminal is capable of partial approval otherwise false.
`final Optional<String>`	`pin()`	Simulate entering a PIN.
`final Optional<TransactionSimulateAuthorizationParams.Status>`	`status()`	Type of event to simulate.
`final JsonField<Long>`	`_amount()`	Returns the raw JSON value of amount.
`final JsonField<String>`	`_descriptor()`	Returns the raw JSON value of descriptor.
`final JsonField<String>`	`_pan()`	Returns the raw JSON value of pan.
`final JsonField<String>`	`_mcc()`	Returns the raw JSON value of mcc.
`final JsonField<String>`	`_merchantAcceptorId()`	Returns the raw JSON value of merchantAcceptorId.
`final JsonField<Long>`	`_merchantAmount()`	Returns the raw JSON value of merchantAmount.
`final JsonField<String>`	`_merchantCurrency()`	Returns the raw JSON value of merchantCurrency.
`final JsonField<Boolean>`	`_partialApprovalCapable()`	Returns the raw JSON value of partialApprovalCapable.
`final JsonField<String>`	`_pin()`	Returns the raw JSON value of pin.
`final JsonField<TransactionSimulateAuthorizationParams.Status>`	`_status()`	Returns the raw JSON value of status.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final TransactionSimulateAuthorizationParams.Builder`	`toBuilder()`
`final TransactionSimulateAuthorizationParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static TransactionSimulateAuthorizationParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of TransactionSimulateAuthorizationParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - amount
```
 final 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.
  - descriptor
```
 final String descriptor()
```
    Merchant descriptor.
  - pan
```
 final String pan()
```
    Sixteen digit card number.
  - mcc
```
 final Optional<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.
  - merchantAcceptorId
```
 final Optional<String> merchantAcceptorId()
```
    Unique identifier to identify the payment card acceptor.
  - merchantAmount
```
 final Optional<Long> merchantAmount()
```
    Amount of the transaction to be simulated in currency specified in merchant_currency, including any acquirer fees.
  - merchantCurrency
```
 final Optional<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
  - partialApprovalCapable
```
 final Optional<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.
  - pin
```
 final Optional<String> pin()
```
    Simulate entering a PIN. If omitted, PIN check will not be performed.
  - status
```
 final Optional<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.
  - _amount
```
 final JsonField<Long> _amount()
```
    Returns the raw JSON value of amount.
    Unlike amount, 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.
  - _pan
```
 final JsonField<String> _pan()
```
    Returns the raw JSON value of pan.
    Unlike pan, this method doesn't throw if the JSON field has an unexpected type.
  - _mcc
```
 final JsonField<String> _mcc()
```
    Returns the raw JSON value of mcc.
    Unlike mcc, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantAcceptorId
```
 final JsonField<String> _merchantAcceptorId()
```
    Returns the raw JSON value of merchantAcceptorId.
    Unlike merchantAcceptorId, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantAmount
```
 final JsonField<Long> _merchantAmount()
```
    Returns the raw JSON value of merchantAmount.
    Unlike merchantAmount, this method doesn't throw if the JSON field has an unexpected type.
  - _merchantCurrency
```
 final JsonField<String> _merchantCurrency()
```
    Returns the raw JSON value of merchantCurrency.
    Unlike merchantCurrency, this method doesn't throw if the JSON field has an unexpected type.
  - _partialApprovalCapable
```
 final JsonField<Boolean> _partialApprovalCapable()
```
    Returns the raw JSON value of partialApprovalCapable.
    Unlike partialApprovalCapable, this method doesn't throw if the JSON field has an unexpected type.
  - _pin
```
 final JsonField<String> _pin()
```
    Returns the raw JSON value of pin.
    Unlike pin, this method doesn't throw if the JSON field has an unexpected type.
  - _status
```
 final JsonField<TransactionSimulateAuthorizationParams.Status> _status()
```
    Returns the raw JSON value of status.
    Unlike status, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final TransactionSimulateAuthorizationParams.Builder toBuilder()
```
  - _body
```
 final TransactionSimulateAuthorizationParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static TransactionSimulateAuthorizationParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of TransactionSimulateAuthorizationParams.
    The following fields are required:
    .amount() .descriptor() .pan()

Class TransactionSimulateAuthorizationParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

amount

descriptor

pan

mcc

merchantAcceptorId

merchantAmount

merchantCurrency

partialApprovalCapable

pin

status

_amount

_descriptor

_pan

_mcc

_merchantAcceptorId

_merchantAmount

_merchantCurrency

_partialApprovalCapable

_pin

_status

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

builder