Class TransactionSimulateVoidParams
-
- All Implemented Interfaces:
-
com.lithic.api.core.Params
public final class TransactionSimulateVoidParams implements Params
Voids a pending authorization. If
amountis not set, the full amount will be voided. Can be used on partially voided transactions but not partially cleared transactions. Simulating an authorization expiry on credit authorizations or credit authorization advice is not currently supported but will be added soon.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTransactionSimulateVoidParams.BuilderA builder for TransactionSimulateVoidParams.
public final classTransactionSimulateVoidParams.Bodypublic final classTransactionSimulateVoidParams.TypeType of event to simulate. Defaults to
AUTHORIZATION_REVERSAL.AUTHORIZATION_EXPIRYindicates authorization has expired and been reversed by Lithic.AUTHORIZATION_REVERSALindicates authorization was reversed by the merchant.
-
Method Summary
Modifier and Type Method Description final Stringtoken()The transaction token returned from the /v1/simulate/authorize response. final Optional<Long>amount()Amount (in cents) to void. final Optional<TransactionSimulateVoidParams.Type>type()Type of event to simulate. final JsonField<String>_token()Returns the raw JSON value of token. final JsonField<Long>_amount()Returns the raw JSON value of amount. final JsonField<TransactionSimulateVoidParams.Type>_type()Returns the raw JSON value of type. 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 TransactionSimulateVoidParams.BuildertoBuilder()final TransactionSimulateVoidParams.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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static TransactionSimulateVoidParams.Builderbuilder()Returns a mutable builder for constructing an instance of TransactionSimulateVoidParams. -
-
Method Detail
-
amount
final Optional<Long> amount()
Amount (in cents) to void. Typically this will match the amount in the original authorization, but can be less. Applies to authorization reversals only. An authorization expiry will always apply to the full pending amount.
-
type
final Optional<TransactionSimulateVoidParams.Type> type()
Type of event to simulate. Defaults to
AUTHORIZATION_REVERSAL.AUTHORIZATION_EXPIRYindicates authorization has expired and been reversed by Lithic.AUTHORIZATION_REVERSALindicates authorization was reversed by the merchant.
-
_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.
-
_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.
-
_type
final JsonField<TransactionSimulateVoidParams.Type> _type()
Returns the raw JSON value of type.
Unlike type, 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 TransactionSimulateVoidParams.Builder toBuilder()
-
_body
final TransactionSimulateVoidParams.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.
-
builder
final static TransactionSimulateVoidParams.Builder builder()
Returns a mutable builder for constructing an instance of TransactionSimulateVoidParams.
The following fields are required:
.token()
-
-
-
-