Transactions
Transactions
Transactions
transactionsGet card transaction
Get a specific card transaction. All amounts are in the smallest unit of their respective currency (e.g., cents for USD).
List card 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.
Expire an authorization
Expire authorization
Simulate authorization
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.
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.
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 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 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
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
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.
Transaction
ShowShow
Globally unique identifier.
The token for the account associated with this transaction.
Fee assessed by the merchant and paid for by the cardholder in the smallest unit of the currency. Will be zero if no fee is assessed. Rebates may be transmitted as a negative value to indicate credited fees.
Unique identifier assigned to a transaction by the acquirer that can be used in dispute and chargeback filing. This field has been deprecated in favor of the acquirer_reference_number that resides in the event-level network_info.
When the transaction is pending, this represents the authorization amount of the transaction in the anticipated settlement currency. Once the transaction has settled, this field represents the settled amount in the settlement currency.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The estimated settled amount of the transaction in the cardholder billing currency.
The exchange rate used to convert the merchant amount to the cardholder billing amount.
3-character alphabetic ISO 4217 currency
Hide ParametersShow Parameters
The pending amount of the transaction in the anticipated settlement currency.
3-character alphabetic ISO 4217 currency
Hide ParametersShow Parameters
The settled amount of the transaction in the merchant currency.
3-character alphabetic ISO 4217 currency
Hide ParametersShow Parameters
The settled amount of the transaction in the settlement currency.
3-character alphabetic ISO 4217 currency
The authorization amount of the transaction in the anticipated settlement currency.
A fixed-width 6-digit numeric identifier that can be used to identify a transaction with networks.
Hide ParametersShow Parameters
Cardholder address
Cardholder ZIP code
Token for the card used in this transaction.
Hide ParametersShow Parameters
The 3DS version used for the authentication
Whether an acquirer exemption applied to the transaction.
Hide ParametersShow Parameters
Indicates what the outcome of the 3DS authentication process is.
Hide ParametersShow Parameters
Indicates which party made the 3DS authentication decision.
Hide ParametersShow Parameters
Indicates whether chargeback liability shift applies to the transaction. Possible enum values:
* `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.
* `ACQUIRER_EXEMPTION`: The acquirer utilised an exemption to bypass Strong Customer Authentication (`transStatus = N`, or `transStatus = I`). Liability remains with the acquirer and in this case the `acquirer_exemption` field is expected to be not `NONE`.
* `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.
TOKEN_AUTHENTICATED: The transaction was a tokenized payment with validated cryptography, possibly recurring. Chargeback liability shift to the issuer applies.
Hide ParametersShow Parameters
Unique identifier you can use to match a given 3DS authentication (available via the three_ds_authentication.created event webhook) and the transaction. Note that in cases where liability shift does not occur, this token is matched to the transaction on a best-effort basis.
Indicates whether a 3DS challenge flow was used, and if so, what the verification method was. (deprecated, use authentication_result)
Hide ParametersShow Parameters
Indicates whether a transaction is considered 3DS authenticated. (deprecated, use authentication_result)
Hide ParametersShow Parameters
Indicates the method used to authenticate the cardholder.
Hide ParametersShow Parameters
Date and time when the transaction first occurred. UTC time zone.
Hide ParametersShow Parameters
Unique alphanumeric identifier for the payment card acceptor (merchant).
Unique numeric identifier of the acquiring institution.
City of card acceptor. Note that in many cases, particularly in card-not-present transactions, merchants may send through a phone number or URL in this field.
Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
Short description of card acceptor.
Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is used to classify a business by the types of goods or services it provides.
Geographic state of card acceptor.
Analogous to the 'amount', but in the merchant currency.
Analogous to the 'authorization_amount', but in the merchant currency.
3-character alphabetic ISO 4217 code for the local currency of the transaction.
Card network of the authorization. Value is UNKNOWN when Lithic cannot determine the network code from the upstream provider.
Hide ParametersShow Parameters
Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Card presence indicator
Hide ParametersShow Parameters
Cardholder presence indicator
Hide ParametersShow Parameters
Method of entry for the PAN
Hide ParametersShow Parameters
Indicates whether the cardholder entered the PIN. True if the PIN was entered.
Hide ParametersShow Parameters
True if a clerk is present at the sale.
True if the terminal is capable of retaining the card.
True if the sale was made at the place of business (vs. mobile).
The person that is designated to swipe the card
Hide ParametersShow Parameters
True if the terminal is capable of partial approval. Partial approval is when part of a transaction is approved and another payment must be used for the remainder. Example scenario: A $40 transaction is attempted on a prepaid card with a $25 balance. If partial approval is enabled, $25 can be authorized, at which point the POS will prompt the user for an additional payment of $15.
Status of whether the POS is able to accept PINs
Hide ParametersShow Parameters
POS Type
Hide ParametersShow Parameters
Uniquely identifies a terminal at the card acceptor location of acquiring institutions or merchant POS Systems
Hide ParametersShow Parameters
The settled amount of the transaction in the settlement currency.
Status of the transaction.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The wallet_type field will indicate the source of the token. Possible token sources include digital wallets (Apple, Google, or Samsung Pay), merchant tokenization, and “other” sources like in-flight commerce. Masterpass is not currently supported and is included for future use.
Hide ParametersShow Parameters
Date and time when the transaction last updated. UTC time zone.
Hide ParametersShow Parameters
Transaction event identifier.
Amount of the event in the settlement currency.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Amount of the event in the cardholder billing currency.
Exchange rate used to convert the merchant amount to the cardholder billing amount.
3-character alphabetic ISO 4217 currency
Hide ParametersShow Parameters
Amount of the event in the merchant currency.
3-character alphabetic ISO 4217 currency
Hide ParametersShow Parameters
Amount of the event, if it is financial, in the settlement currency. Non-financial events do not contain this amount because they do not move funds.
Exchange rate used to convert the merchant amount to the settlement amount.
3-character alphabetic ISO 4217 currency
RFC 3339 date and time this event entered the system. UTC time zone.
Hide ParametersShow Parameters
Indicates whether the transaction event is a credit or debit to the account.
Hide ParametersShow Parameters
Information provided by the card network in each event. This includes common identifiers shared between you, Lithic, the card network and in some cases the acquirer. These identifiers often link together events within the same transaction lifecycle and can be used to locate a particular transaction, such as during processing of disputes. Not all fields are available in all events, and the presence of these fields is dependent on the card network and the event type. If the field is populated by the network, we will pass it through as is unless otherwise specified. Please consult the official network documentation for more details about these fields and how to use them.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Identifier assigned by the acquirer, applicable to dual-message transactions only. The acquirer reference number (ARN) is only populated once a transaction has been cleared, and it is not available in all transactions (such as automated fuel dispenser transactions). A single transaction can contain multiple ARNs if the merchant sends multiple clearings.
Identifier assigned by the acquirer.
Hide ParametersShow Parameters
Identifier assigned by American Express. Matches the transaction_id of a prior related event. May be populated in incremental authorizations (authorization requests that augment a previously authorized amount), authorization advices, financial authorizations, and clearings.
Identifier assigned by American Express to link original messages to subsequent messages. Guaranteed by American Express to be unique for each original authorization and financial authorization.
Hide ParametersShow Parameters
Identifier assigned by Mastercard. Guaranteed by Mastercard to be unique for any transaction within a specific financial network on any processing day.
Identifier assigned by Mastercard. Matches the banknet_reference_number of a prior related event. May be populated in authorization reversals, incremental authorizations (authorization requests that augment a previously authorized amount), automated fuel dispenser authorization advices and clearings, and financial authorizations. If the original banknet reference number contains all zeroes, then no actual reference number could be found by the network or acquirer. If Mastercard converts a transaction from dual-message to single-message, such as for certain ATM transactions, it will populate the original banknet reference number in the resulting financial authorization with the banknet reference number of the initial authorization, which Lithic does not receive.
Identifier assigned by Mastercard. Matches the switch_serial_number of a prior related event. May be populated in returns and return reversals. Applicable to single-message transactions only.
Identifier assigned by Mastercard, applicable to single-message transactions only.
Hide ParametersShow Parameters
Identifier assigned by Visa. Matches the transaction_id of a prior related event. May be populated in incremental authorizations (authorization requests that augment a previously authorized amount), authorization advices, financial authorizations, and clearings.
Identifier assigned by Visa to link original messages to subsequent messages. Guaranteed by Visa to be unique for each original authorization and financial authorization.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The Auth Rule Token associated with the rule from which the decline originated. If this is set to null, then the decline was not associated with a customer-configured Auth Rule. This may happen in cases where a transaction is declined due to a Lithic-configured security or compliance rule, for example.
A human-readable explanation outlining the motivation for the rule's decline.
The name for the rule, if any was configured.
The detailed_result associated with this rule's decline.
Hide ParametersShow Parameters
Type of transaction event
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Hide ParametersShow Parameters
Indicates the electronic commerce security level and UCAF collection.
The On-behalf Service performed on the transaction and the results. Contains all applicable, on-behalf service results that were performed on a given transaction.
Hide ParametersShow Parameters
Indicates the results of the service processing.
Identifies the results of the service processing.
Indicates the service performed on the transaction.
Indicates the type of additional transaction purpose.
Hide ParametersShow Parameters
Identifies the purpose or category of a transaction, used to classify and process transactions according to Visa’s rules.
TransactionsEnhanced Commercial Data
transactions.enhanced_commercial_dataList enhanced commercial data
Get all L2/L3 enhanced commercial data associated with a transaction. Not available in sandbox.
TransactionsEvents
transactions.eventsTransactionsEventsEnhanced Commercial Data
transactions.events.enhanced_commercial_dataGet enhanced commercial data
Get L2/L3 enhanced commercial data associated with a transaction event. Not available in sandbox.
Enhanced Data
ShowShow
A unique identifier for the enhanced commercial data.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The price of the item purchased in merchant currency.
A human-readable description of the item.
An identifier for the item purchased.
The quantity of the item purchased.
Hide ParametersShow Parameters
The amount of tax collected.
A flag indicating whether the transaction is tax exempt or not.
Hide ParametersShow Parameters
The tax ID of the merchant.
A customer identifier.
A merchant identifier.
The date of the order.
The token of the event that the enhanced data is associated with.
Hide ParametersShow Parameters
Hide ParametersShow Parameters
The discount applied to the gross sale amount.
The gross sale amount.
The amount after discount.
Hide ParametersShow Parameters
The quantity of fuel purchased.
The type of fuel purchased.
Hide ParametersShow Parameters
Unit of measure for fuel disbursement.
Hide ParametersShow Parameters
The price per unit of fuel.
The driver number entered into the terminal at the time of sale, with leading zeros stripped.
The odometer reading entered into the terminal at the time of sale.
The type of fuel service.
Hide ParametersShow Parameters
The vehicle number entered into the terminal at the time of sale, with leading zeros stripped.
The token of the transaction that the enhanced data is associated with.