lithic-kotlin-root/com.lithic.api.services.blocking/TransactionServiceImpl

TransactionServiceImpl

class TransactionServiceImpl : TransactionService

Types

WithRawResponseImpl

class WithRawResponseImpl : TransactionService.WithRawResponse

Functions

enhancedCommercialData

open override fun enhancedCommercialData(): EnhancedCommercialDataService

events

open override fun events(): EventService

expireAuthorization

open fun expireAuthorization(transactionToken: String, requestOptions: RequestOptions)

open override fun expireAuthorization(params: TransactionExpireAuthorizationParams, requestOptions: RequestOptions)

open fun expireAuthorization(transactionToken: String, params: TransactionExpireAuthorizationParams = TransactionExpireAuthorizationParams.none(), requestOptions: RequestOptions = RequestOptions.none())

Expire authorization

list

open fun list(requestOptions: RequestOptions): TransactionListPage

open override fun list(params: TransactionListParams, requestOptions: RequestOptions): TransactionListPage

List card transactions. All amounts are in the smallest unit of their respective currency (e.g., cents for USD) and inclusive of any acquirer fees.

retrieve

open fun retrieve(transactionToken: String, requestOptions: RequestOptions): Transaction

open override fun retrieve(params: TransactionRetrieveParams, requestOptions: RequestOptions): Transaction

open fun retrieve(transactionToken: String, params: TransactionRetrieveParams = TransactionRetrieveParams.none(), requestOptions: RequestOptions = RequestOptions.none()): Transaction

Get a specific card transaction. All amounts are in the smallest unit of their respective currency (e.g., cents for USD).

simulateAuthorization

open override fun simulateAuthorization(params: TransactionSimulateAuthorizationParams, requestOptions: RequestOptions): TransactionSimulateAuthorizationResponse

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.

simulateAuthorizationAdvice

open override fun simulateAuthorizationAdvice(params: TransactionSimulateAuthorizationAdviceParams, requestOptions: RequestOptions): TransactionSimulateAuthorizationAdviceResponse

Simulates an authorization advice from the card network as if it came from a merchant acquirer. An authorization advice changes the pending amount of the transaction.

simulateClearing

open override fun simulateClearing(params: TransactionSimulateClearingParams, requestOptions: RequestOptions): TransactionSimulateClearingResponse

Clears an existing authorization, either debit or credit. After this event, the transaction transitions from PENDING to SETTLED status.

simulateCreditAuthorization

open override fun ~~simulateCreditAuthorization~~(params: TransactionSimulateCreditAuthorizationParams, requestOptions: RequestOptions): TransactionSimulateCreditAuthorizationResponse

Simulates a credit authorization advice from the card network. This message indicates that the network approved a credit authorization on your behalf.

simulateCreditAuthorizationAdvice

open override fun simulateCreditAuthorizationAdvice(params: TransactionSimulateCreditAuthorizationAdviceParams, requestOptions: RequestOptions): TransactionSimulateCreditAuthorizationAdviceResponse

Simulates a credit authorization advice from the card network. This message indicates that the network approved a credit authorization on your behalf.

simulateReturn

open override fun simulateReturn(params: TransactionSimulateReturnParams, requestOptions: RequestOptions): TransactionSimulateReturnResponse

Returns, or refunds, an amount back to a card. Returns simulated via this endpoint clear immediately, without prior authorization, and result in a SETTLED transaction status.

simulateReturnReversal

open override fun simulateReturnReversal(params: TransactionSimulateReturnReversalParams, requestOptions: RequestOptions): TransactionSimulateReturnReversalResponse

Reverses a return, i.e. a credit transaction with a SETTLED status. Returns can be financial credit authorizations, or credit authorizations that have cleared.

simulateVoid

open override fun simulateVoid(params: TransactionSimulateVoidParams, requestOptions: RequestOptions): TransactionSimulateVoidResponse

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.

withOptions

open override fun withOptions(modifier: (ClientOptions.Builder) -> Unit): TransactionService

Returns a view of this service with the given option modifications applied.

withRawResponse

open override fun withRawResponse(): TransactionService.WithRawResponse

Returns a view of this service that provides access to raw HTTP responses for each method.