Builder

Functions

Link copied to clipboard

Sets Builder.accountType to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.additionalData to an arbitrary JSON value.

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).

Link copied to clipboard

Sets Builder.app to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.authenticationRequestType to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.browser to an arbitrary JSON value.

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

Link copied to clipboard
Link copied to clipboard

Sets Builder.cardExpiryCheck to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.cardholder to an arbitrary JSON value.

Object containing data about the cardholder provided during the transaction.

Link copied to clipboard

Sets Builder.cardToken to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.challengeMetadata to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.challengeOrchestratedBy to an arbitrary JSON value.

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).

Link copied to clipboard

Sets Builder.channel to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.created to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.decisionMadeBy to an arbitrary JSON value.

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).

Link copied to clipboard

Sets Builder.merchant to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.messageCategory to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.threeRiRequestType to an arbitrary JSON value.

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.

Link copied to clipboard

Sets Builder.token to an arbitrary JSON value.

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

Link copied to clipboard

Sets Builder.transaction to an arbitrary JSON value.

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