ThreeDS

Last updated: (timestamp)

ThreeDS

three_ds

ThreeDSAuthentication

three_ds.authentication

Methods

Get 3DS authentication

get/v1/three_ds_authentication/{three_ds_authentication_token}

Get 3DS Authentication by token

Simulate 3DS authentication

post/v1/three_ds_authentication/simulate

Simulates a 3DS authentication request from the payment network as if it came from an ACS. If you're configured for 3DS Customer Decisioning, simulating authentications requires your customer decisioning endpoint to be set up properly (respond with a valid JSON). If the authentication decision is to challenge, ensure that the account holder associated with the card transaction has a valid phone number configured to receive the OTP code via SMS.

Simulate entering OTP into 3DS Challenge UI

post/v1/three_ds_decisioning/simulate/enter_otp

Endpoint for simulating entering OTP into 3DS Challenge UI. A call to /v1/three_ds_authentication/simulate that resulted in triggered SMS-OTP challenge must precede. Only a single attempt is supported; upon entering OTP, the challenge is either approved or declined.

ThreeDSDecisioning

three_ds.decisioning

Methods

Respond to a Challenge Request

post/v1/three_ds_decisioning/challenge_response

Card program's response to a 3DS Challenge Request. Challenge Request is emitted as a webhook three_ds_authentication.challenge and your Card Program needs to be configured with Out of Band (OOB) Challenges in order to receive it (see https://docs.lithic.com/docs/3ds-challenge-flow for more information).

Retrieve the 3DS Decisioning HMAC secret key

get/v1/three_ds_decisioning/secret

Retrieve the 3DS Decisioning HMAC secret key. If one does not exist for your program yet, calling this endpoint will create one for you. The headers (which you can use to verify 3DS Decisioning requests) will begin appearing shortly after calling this endpoint for the first time. See this page for more detail about verifying 3DS Decisioning requests.

Rotate the 3DS Decisioning HMAC secret key

post/v1/three_ds_decisioning/secret/rotate

Generate a new 3DS Decisioning HMAC secret key. The old secret key will be deactivated 24 hours after a successful request to this endpoint. Make a GET /three_ds_decisioning/secret request to retrieve the new secret key.

Domain Types

Challenge Response

ChallengeResponseobject

Response from Card Program to a 3DS Authentication challenge

ShowShow

tokenstring

Globally unique identifier for 3DS Authentication that resulted in PENDING_CHALLENGE authentication result.

formatuuid

challenge_response

Whether the Cardholder has approved or declined the issued Challenge

Challenge Result

ChallengeResultenum

Whether the Cardholder has approved or declined the issued Challenge

ShowShow

"APPROVE"

"DECLINE_BY_CUSTOMER"