Classic Payments integration v68 - Get the 3DS authentication result

Request parameters

Required Optional

merchantAccount string Required

The merchant account identifier, with which the authentication was processed.

pspReference string Required

The pspReference identifier for the transaction.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK

The request has succeeded.
Show more Show less
threeDS1Result object

The result of the 3D Secure authentication.

Show children Hide children

cavv string

The cardholder authentication value (base64 encoded).

cavvAlgorithm string

The CAVV algorithm used.

eci string

3D Secure Electronic Commerce Indicator (ECI).

threeDAuthenticatedResponse string

The authentication response from the ACS.

threeDOfferedResponse string

Whether 3D Secure was offered or not.

xid string

A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in Base64 encoding.

threeDS2Result object

The result of the 3D Secure 2 authentication.

Show children Hide children

authenticationValue string

The authenticationValue value as defined in the 3D Secure 2 specification.

cavvAlgorithm string

The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.

challengeCancel string

Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to 3D Secure API reference.

dsTransID string

The dsTransID value as defined in the 3D Secure 2 specification.

eci string

The eci value as defined in the 3D Secure 2 specification.

exemptionIndicator string

Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values:

lowValue

secureCorporate

trustedBeneficiary

transactionRiskAnalysis

messageVersion string

The messageVersion value as defined in the 3D Secure 2 specification.

riskScore string

Risk score calculated by Cartes Bancaires Directory Server (DS).

threeDSRequestorChallengeInd string

Indicates whether a challenge is requested for this transaction. Possible values:

01 — No preference

02 — No challenge requested

03 — Challenge requested (3DS Requestor preference)

04 — Challenge requested (Mandate)

05 — No challenge (transactional risk analysis is already performed)

06 — Data Only

threeDSServerTransID string

The threeDSServerTransID value as defined in the 3D Secure 2 specification.

timestamp string

The timestamp value of the 3D Secure 2 authentication.

transStatus string

The transStatus value as defined in the 3D Secure 2 specification.

transStatusReason string

Provides information on why the transStatus field has the specified value. For possible values, refer to our docs.

whiteListStatus string

The whiteListStatus value as defined in the 3D Secure 2 specification.
400 - Bad Request

A problem reading or understanding the request.
Show more Show less
additionalData object

Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.

errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
401 - Unauthorized

Authentication required.
Show more Show less
additionalData object

Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.

errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
403 - Forbidden

Insufficient permissions to process the request.
Show more Show less
additionalData object

Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.

errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
422 - Unprocessable Entity

A request validation error.
Show more Show less
additionalData object

Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.

errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.
500 - Internal Server Error

The server could not process the request.
Show more Show less
additionalData object

Contains additional information about the payment. Some data fields are included only if you select them first. Go to Customer Area > Developers > Additional data.

errorCode string

The error code mapped to the error message.

errorType string

The category of the error.

message string

A short explanation of the issue.

pspReference string

The PSP reference of the payment.

status integer

The HTTP response status.

Get the 3DS authentication result

Endpoint destination URL

Request parameters

Response parameters

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error