Lithic API Documentation | Transactions › Simulate Authorization

Transactions

transactions

Methods

List Card Transactions -> CursorPage<

get/v1/transactions

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.

Get Card Transaction ->

Transaction

get/v1/transactions/{transaction_token}

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

Simulate Authorization -> { token, debugging_request_id }

post/v1/simulate/authorize

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.

Response fields

token: string

Optional

(format: uuid)

A unique token to reference this transaction with later calls to void or clear the authorization.

debugging_request_id: string

Optional

(format: uuid)

Debugging request ID to share with Lithic Support team.

Request example

curl https://api.lithic.com/v1/simulate/authorize \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
          "amount": 3831,
          "descriptor": "COFFEE SHOP",
          "pan": "4111111289144142",
          "mcc": "5812",
          "merchant_acceptor_id": "OODKZAPJVN4YS7O",
          "merchant_currency": "GBP",
          "pin": "1234",
          "status": "AUTHORIZATION"
        }'

200Example

{
  "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "debugging_request_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}

Simulate Clearing -> { debugging_request_id }

post/v1/simulate/clearing

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

If amount is 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.

Simulate Return -> { token, debugging_request_id }

post/v1/simulate/return

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.

Simulate Return Reversal -> { debugging_request_id }

post/v1/simulate/return_reversal

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

Simulate Void -> { debugging_request_id }

post/v1/simulate/void

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.

Simulate Credit Authorization Advice -> { token, debugging_request_id }

post/v1/simulate/credit_authorization_advice

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

Simulate Authorization Advice -> { token, debugging_request_id }

post/v1/simulate/authorization_advice

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.

Expire An Authorization ->

post/v1/transactions/{transaction_token}/expire_authorization

Expire authorization

Domain types

CardholderAuthentication = { authentication_method, authentication_result, decision_made_by, 2 more... }

TokenInfo = { wallet_type }

Transaction = { token, account_token, acquirer_fee, 23 more... }

Transactions

Enhanced Commercial Data

transactions.enhanced_commercial_data

Methods

List Enhanced Commercial Data -> { data }

get/v1/transactions/{transaction_token}/enhanced_commercial_data

Get all L2/L3 enhanced commercial data associated with a transaction. Not available in sandbox.

Transactions

Events

transactions.events

Transactions Events

Enhanced Commercial Data

transactions.events.enhanced_commercial_data

Methods

Get Enhanced Commercial Data ->

EnhancedData

get/v1/transactions/events/{event_token}/enhanced_commercial_data

Get L2/L3 enhanced commercial data associated with a transaction event. Not available in sandbox.

Domain types

EnhancedData = { token, common, event_token, 2 more... }