Class TransactionSimulateClearingParams
-
- All Implemented Interfaces:
-
com.lithic.api.core.Params
public final class TransactionSimulateClearingParams implements Params
Clears an existing authorization, either debit or credit. After this event, the transaction transitions from
PENDINGtoSETTLEDstatus.If
amountis not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classTransactionSimulateClearingParams.Bodypublic final classTransactionSimulateClearingParams.BuilderA builder for TransactionSimulateClearingParams.
-
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 clear. final JsonField<String>_token()The transaction token returned from the /v1/simulate/authorize response. final JsonField<Long>_amount()Amount (in cents) to clear. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()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. final TransactionSimulateClearingParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static TransactionSimulateClearingParams.Builderbuilder()Returns a mutable builder for constructing an instance of TransactionSimulateClearingParams. -
-
Method Detail
-
amount
final Optional<Long> amount()
Amount (in cents) to clear. Typically this will match the amount in the original authorization, but can be higher or lower. The sign of this amount will automatically match the sign of the original authorization's amount. For example, entering 100 in this field will result in a -100 amount in the transaction, if the original authorization is a credit authorization.
If
amountis not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.
-
_token
final JsonField<String> _token()
The transaction token returned from the /v1/simulate/authorize response.
-
_amount
final JsonField<Long> _amount()
Amount (in cents) to clear. Typically this will match the amount in the original authorization, but can be higher or lower. The sign of this amount will automatically match the sign of the original authorization's amount. For example, entering 100 in this field will result in a -100 amount in the transaction, if the original authorization is a credit authorization.
If
amountis not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_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.
-
toBuilder
final TransactionSimulateClearingParams.Builder toBuilder()
-
builder
final static TransactionSimulateClearingParams.Builder builder()
Returns a mutable builder for constructing an instance of TransactionSimulateClearingParams.
The following fields are required:
.token()
-
-
-
-