three_ds_authentication.created

wbhk

Occurs when a 3DS authentication is created.

Payload

event_type

const

enum

required

The type of event that occurred.

Allowed:

account_type

string | null

enum

required

Type of account/card that is being used for the transaction. Maps to EMV 3DS field acctType.

Allowed:

additional_data

object | null

Object containing additional data about the 3DS request that is beyond the EMV 3DS standard spec (e.g., specific fields that only certain card networks send but are not required across all 3DS requests).

app

object | null

Object containing data about the app used in the e-commerce transaction. Present if the channel is 'APP_BASED'.

authentication_request_type

string | null

enum

Type of authentication request - i.e., the type of transaction or interaction is causing the merchant to request an authentication. Maps to EMV 3DS field threeDSRequestorAuthenticationInd.

authentication_result

string

enum

required

Indicates the outcome of the 3DS authentication process.

Allowed:

browser

object | null

Object containing data about the browser used in the e-commerce transaction. Present if the channel is 'BROWSER'.

card_expiry_check

string

enum

required

Indicates whether the expiration date provided by the cardholder during checkout matches Lithic's record of the card's expiration date.

Allowed:

card_token

uuid

required

Globally unique identifier for the card on which the 3DS authentication has occurred. Permitted values: 36-digit version 4 UUID (including hyphens).

cardholder

object

required

Object containing data about the cardholder provided during the transaction.

challenge_metadata

object | null

Metadata about the challenge method and delivery. Only present when a challenge is triggered.

challenge_orchestrated_by

string | null

enum

Entity that orchestrates the challenge. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request).

Allowed:

channel

string

enum

required

Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.

Allowed:

created

date-time

required

Date and time when the authentication was created in Lithic's system. Permitted values: Date string in the ISO 8601 format yyyy-MM-dd'T'hh:mm:ssZ.

decision_made_by

string | null

enum

Entity that made the authentication decision. This won't be set for authentications for which a decision has not yet been made (e.g. in-flight customer decisioning request).

Allowed:

merchant

object

required

Object containing data about the merchant involved in the e-commerce transaction.

message_category

string

enum

required

Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not populated.

Allowed:

three_ds_requestor_challenge_indicator

string

enum

required

Indicates whether a challenge is requested for this transaction

NO_PREFERENCE - No Preference
NO_CHALLENGE_REQUESTED - No Challenge Requested
CHALLENGE_PREFERENCE - Challenge requested (3DS Requestor preference)
CHALLENGE_MANDATE - Challenge requested (Mandate)
NO_CHALLENGE_RISK_ALREADY_ASSESSED - No Challenge requested (Transactional risk analysis is already performed)
DATA_SHARE_ONLY - No Challenge requested (Data Share Only)
OTHER - Other indicators not captured by above. These are rarely used

Allowed:

three_ri_request_type

string | null

enum

Type of 3DS Requestor Initiated (3RI) request — i.e., a 3DS authentication that takes place at the initiation of the merchant rather than the cardholder. The most common example of this is where a merchant is authenticating before billing for a recurring transaction such as a pay TV subscription or a utility bill. Maps to EMV 3DS field threeRIInd.

token

uuid

required

Globally unique identifier for the 3DS authentication. Permitted values: 36-digit version 4 UUID (including hyphens).

transaction

object | null

Object containing data about the e-commerce transaction for which the merchant is requesting authentication.

Response

200

Return a 200 status to indicate that the data was received successfully