Challenge

If performing 3DS in the browser, you must prepare the Challenge Request (CReq), send it to the ACS, and decode the Challenge Response (CRes). See the Browser Integration Guide for more information.

The formats of the CReq and CRes are shown below.

If performing 3DS in a mobile app using the 3DS SDKs, the SDKs will prepare the CReq and decode the CRes for you. See the App Integration Guide for more information.

Field Status Definitions
Required Required fields must be sent. If the data is not sent Ravelin will return an error.
Important Important fields are crucial for performance.
Optional Optional fields are additional data points that can be shared with the card schemes, issuers, and Ravelin. These fields may impact performance or dashboard usability.
Conditional Fields that may be required under certain conditions.

Challenge Request

Show all
messageType string
2.1.0 2.2.0
APP BRW
required

The 3DS message type. Must always be set to "CReq".

Example: "CReq"
messageVersion string
2.1.0 2.2.0
APP BRW
required

The 3DS protocol version identifier. Should be set to the same value as in the Authenticate Response.

threeDSServerTransID string
2.1.0 2.2.0
APP BRW
required

The unique identifier (UUID) for tracking the transaction throughout the 3DS process, as found in the Authenticate Response.

Example: "c5584543-b67e-5117-bb34-3567ac6a1123"
acsTransID string
2.1.0 2.2.0
APP BRW
required

The unique identifier (UUID) for tracking the transaction throughout the 3DS process, as found in the Authenticate Response.

Example: "214a549e-2310-4359-b590-c53a20adcc78"
challengeWindowSize string
2.1.0 2.2.0
BRW
required

Dimensions of the challenge window that will been displayed to the cardholder. The ACS shall reply with content that is formatted to appropriately render in this window to provide the best possible user experience.

Preconfigured sizes are width x height in pixels.

Options:
01 250px x 400px
02 390px x 400px
03 500px x 600px
04 600px x 400px
05 Full screen

Challenge Response

Show all
messageType string
2.1.0 2.2.0
APP BRW

The 3DS message type. Will always be "CRes".

Example: "CRes"
messageVersion string
2.1.0 2.2.0
APP BRW

The 3DS protocol version identifier.

threeDSServerTransID string
2.1.0 2.2.0
APP BRW

The unique identifier (UUID) for tracking the transaction throughout the 3DS process.

Example: "c5584543-b67e-5117-bb34-3567ac6a1123"
acsTransID string
2.1.0 2.2.0
APP BRW

The unique identifier (UUID) used by the ACS for tracking the transaction throughout the 3DS process.

Example: "214a549e-2310-4359-b590-c53a20adcc78"
transStatus string
2.1.0 2.2.0
APP BRW

Indicates the outcome of the challenge request.

Options:
Y Authentication Successful

The authentication was successful, make a Result Request to acquire the authenticationValue.

N Authentication Failed

The authentication failed, make a Result Request to learn the reason for the failure.

Feedback