Skip to main content

Get 3DS Session Details

GET 

/3DS-sessions/:id

Returns the details of a 3DS session and indicates the outcome of the 3DS authentication.

info

This endpoint uses the SmartPay BaseURL and Authorization.

Request​

Path Parameters

Header Parameters

    Content-Type stringrequired

    Must be application/json

    Accept-Language stringrequired

    Must be be en-US

    Origin stringrequired

    The origin of the request

    User-Agent stringrequired

    The client making the request

    Authorization stringrequired

    Basic M2lwN2Yx...OGU3Mg==

Responses​

3DS authentication status successfully returned

warning

From the received response, please extract the mandatory 6 parameters below and be prepared to provide those parameters for the endpoints Create 3DS Payment or Card on File(/docs/smartpay-openapi/create-card-on-file). - acsEci - authenticationToken - transactionStatus - protocolVersion - dsTransactionId - acsTransactionId

Schema
    3ds object

    Contains the 3D Secure authentication result details.

    versionstring

    Specifies the 3DS protocol version used during the authentication.

    Possible values: [3DS2]

    Example: 3DS2
    3ds2 object

    Contains 3DS2-specific fields and nested authentication data.

    3dsMethod object

    Contains metadata related to the 3DS Method which allows for frictionless authentication.

    redirectHtmlstring<html>

    HTML content used to embed an iframe that automatically performs the 3DS method call.

    3dsMethodPostDatastring

    Encoded data to be posted to the Access Control Server (ACS) for the 3DS method.

    3dsMethodUrlstring<uri>

    Endpoint of the Access Control Server to which the 3dsMethodPostData is submitted.

    challengeData object

    Contains data related to the challenge flow if the issuer requires step-up authentication.

    acsUrlstring<uri>

    The URL of the Access Control Server (ACS) for executing the challenge flow.

    cReqstring

    The encoded CReq (Challenge Request) payload sent to the ACS for initiating the challenge.

    redirectHtmlstring<html>

    HTML used to render and submit the CReq form inside an iframe for challenge completion.

    acsEcistring

    Electronic Commerce Indicator (ECI) value returned by the ACS. Indicates the outcome of authentication.

    Possible values: <= 2 characters

    Example: 02
    authenticationTokenstring

    Authentication token to be submitted for subsequent MIT payments or storing card data.

    Possible values: <= 64 characters

    transactionIdstring<uuid>

    Unique transaction identifier generated by the 3DS provider for tracking this session.

    3dsServerTransactionIdstring<uuid>

    Identifier generated by the 3DS Server for this authentication session.

    acsTransactionIdstring<uuid>

    Unique transaction ID assigned by the ACS to this session.

    directoryServerIdstring

    Identifier for the directory server used in the 3DS process (e.g., Visa, Mastercard, etc.).

    Possible values: <= 20 characters

    dsTransactionIdstring<uuid>

    Unique transaction ID assigned by the Directory Server.

    methodCompletedboolean

    Indicates whether the 3DS method call has been completed.

    methodSupportedstring

    Indicates whether the 3DS method is supported by the cardholder's issuing bank.

    Possible values: [SUPPORTED, NOT_SUPPORTED]

    protocolVersionstring

    Version of the 3DS protocol used during the authentication process.

    Possible values: [2.1.0, 2.2.0]

    requestorIdstring

    The identifier of the requesting party (e.g., the merchant or PSP).

    Possible values: <= 64 characters

    requestorNamestring

    The name of the requesting party.

    Possible values: <= 255 characters

    transactionStatusstring

    Final status of the 3DS transaction:

    • Y: Authentication/Account verification successful
    • N: Not authenticated / Account not verified / Transaction denied
    • U: Authentication could not be performed
    • A: Attempts processing performed
    • R: Authentication/Account verification rejected

    Possible values: [Y, N, U, A, R]

    device object

    Metadata about the device and browser used for the authentication.

    browserstring

    User-agent string of the customer's browser.

    Possible values: <= 512 characters

    browserDetails object

    Technical attributes and capabilities of the customer's browser.

    acceptHeadersstring

    The Accept HTTP headers sent by the browser.

    Possible values: <= 256 characters

    colorDepthinteger

    Color depth of the browser's screen in bits.

    Example: 24
    javaEnabledboolean

    Indicates whether Java is enabled in the browser.

    javaScriptEnabledboolean

    Indicates whether JavaScript is enabled in the browser.

    languagestring

    Language setting of the browser (e.g., 'en', 'de').

    Possible values: <= 8 characters

    screenHeightinteger

    Height of the user's screen in pixels.

    screenWidthinteger

    Width of the user's screen in pixels.

    3DSecureChallengeWindowSizestring

    Preferred window size for the 3DS challenge iframe display.

    Possible values: [250x400, 390x400, 500x600, 600x400, FULL_SCREEN]

    ipAddressstring<ipv4>

    IP address of the customer's device.