lithic-kotlin-root/com.lithic.api.models/TransactionSimulateVoidParams

TransactionSimulateVoidParams

class TransactionSimulateVoidParams : Params

Voids a pending authorization. If amount is 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.

Types

Body

class Body

Builder

class Builder

A builder for TransactionSimulateVoidParams.

Companion

object Companion

Type

class Type : Enum

Type of event to simulate. Defaults to AUTHORIZATION_REVERSAL.

Functions

_additionalBodyProperties

fun _additionalBodyProperties(): Map<String, JsonValue>

_additionalHeaders

fun _additionalHeaders(): Headers

Additional headers to send with the request.

_additionalQueryParams

fun _additionalQueryParams(): QueryParams

Additional query param to send with the request.

_amount

fun _amount(): JsonField<Long>

Returns the raw JSON value of amount.

_body

fun _body(): TransactionSimulateVoidParams.Body

_headers

open override fun _headers(): Headers

The full set of headers in the parameters, including both fixed and additional headers.

_queryParams

open override fun _queryParams(): QueryParams

The full set of query params in the parameters, including both fixed and additional query params.

_token

fun _token(): JsonField<String>

Returns the raw JSON value of token.

_type

fun _type(): JsonField<TransactionSimulateVoidParams.Type>

Returns the raw JSON value of type.

amount

fun amount(): Long?

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.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toBuilder

fun toBuilder(): TransactionSimulateVoidParams.Builder

token

fun token(): String

The transaction token returned from the /v1/simulate/authorize response.

toString

open override fun toString(): String

type

fun type(): TransactionSimulateVoidParams.Type?

Type of event to simulate. Defaults to AUTHORIZATION_REVERSAL.