Auth Stream Access Request

Auth Stream Access Request

Payload
const
enum
required
Allowed:
merchant
object
required

Merchant information including full location details.

required
avs
object
required
card
object
required

Card object in ASA

cardholder_authentication
object
pos
object
int64
required
deprecated

Deprecated, use amounts. Authorization amount of the transaction (in cents), including any acquirer fees. The contents of this field are identical to authorization_amount.

int64
required

Fee (in cents) assessed by the merchant and paid for by the cardholder. Will be zero if no fee is assessed. Rebates may be transmitted as a negative value to indicate credited fees.

int64
required
deprecated

Deprecated, use amounts. The base transaction amount (in cents) plus the acquirer fee field. This is the amount the issuer should authorize against unless the issuer is paying the acquirer fee on behalf of the cardholder.

string
required
deprecated

Deprecated, use amounts. 3-character alphabetic ISO 4217 code for cardholder's billing currency.

int64
required

The portion of the transaction requested as cash back by the cardholder, and does not include any acquirer fees. The amount field includes the purchase amount, the requested cash back amount, and any acquirer fees.

If no cash back was requested, the value of this field will be 0, and the field will always be present.

int64

Deprecated, use cash_amount.

token_info
object | null
date-time

Deprecated: approximate time-to-live for the authorization.

number
deprecated

Deprecated, use amounts. If the transaction was requested in a currency other than the settlement currency, this field will be populated to indicate the rate used to translate the merchant_amount to the amount (i.e., merchant_amount x conversion_rate = amount). Note that the merchant_amount is in the local currency and the amount is in the settlement currency.

date-time
required

Date and time when the transaction first occurred in UTC.

int64
required
deprecated

Deprecated, use amounts. The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. Note the amount includes acquirer_fee, similar to authorization_amount. It will be different from authorization_amount if the merchant is taking payment in a different currency.

string
required
deprecated

3-character alphabetic ISO 4217 code for the local currency of the transaction.

string
enum

Card network of the authorization.

Allowed:
integer | null

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.

int64
required
deprecated

Deprecated, use amounts. Amount (in cents) of the transaction that has been settled, including any acquirer fees.

amounts
object
required

Structured amounts for this authorization. The cardholder and merchant amounts reflect the original network authorization values. For programs with hold adjustments enabled (e.g., automated fuel dispensers or tipping MCCs), the hold amount may exceed the cardholder and merchant amounts to account for anticipated final transaction amounts such as tips or fuel fill-ups

string
enum
required

The type of authorization request that this request is for. Note that CREDIT_AUTHORIZATION and FINANCIAL_CREDIT_AUTHORIZATION is only available to users with credit decisioning via ASA enabled.

Allowed:
uuid
required

The provisional transaction group uuid associated with the authorization

uuid

The event token associated with the authorization. This field is only set for programs enrolled into the beta.

fleet_info
object | null

Optional Object containing information if the Card is a part of a Fleet managed program

network_specific_data
object | null

Contains raw data provided by the card network, including attributes that provide further context about the authorization. If populated by the network, data is organized by Lithic and passed through without further modification. Please consult the official network documentation for more details about these values and how to use them. This object is only available to certain programs- contact your Customer Success Manager to discuss enabling access.

string | null
enum

The selected account type for applicable ATM transactions such as cash withdrawals, deposits, or balance inquiries.

Allowed:
string
enum
required

The entity that initiated the transaction.

Allowed:
latest_challenge
object

The latest Authorization Challenge that was issued to the cardholder for this merchant.

Headers
uuid

Webhook ID

integer

Unix timestamp used for HMAC verification

string

A list of HMAC signatures encoded in Base64 and separated by spaces. Can contain multiple HMAC signatures as a result of key rotation.

Responses

5XX

Return a HTTP 5XX response to indicate processing failure. This will cause Lithic to immediately retry the request once.

LoadingLoading…