Response Fields
Challenge Response (Direct Integration)
These fields are returned when a 3-D Secure challenge is required and provide the information necessary for you to request the Access Control Server (ACS) perform that challenge.
These fields will be returned in addition to the 3-D Secure initial Request (Hosted and Direct Integration) Request Fields and the Basic Response Fields.
| Field Name | Returned? | Description |
|---|---|---|
| threeDSEnabled | Always | Is 3DS enabled for this Merchant Account? Possible values are: N – Merchant Account is not enabled. Y – Merchant Account is enabled. |
| threeDSPolicy | If available | 3DS Policy used. Refer to the 3-D Secure Direct Implementation section for further details. |
| threeDSXID | If 3DS enabled | The unique identifier for the transaction in the 3DS system. |
| threeDSEnrolled | If 3DS enabled | The 3DS enrolment status for the credit card. Possible values are: Y – Enrolled. N – Not enrolled. U – Unable to verify if enrolled. E – Error verifying enrolment. |
| threeDSRef | If 3DS enabled | Value to return in the continuation request. |
| threeDSURL | If 3DS enrolled | The URL of the ACS to which the challenge data should be sent via a HTTP POST request from the Cardholder’s browser. |
| threeDSRequest | If 3DS enrolled | Record containing the name/value pairs that should be sent to the ACS via HTTP POST request from the Cardholder’s browser. |
Final Response (Hosted and Direct Integration)
These fields are returned when the 3-D Secure stage has completed, and no further challenge is required.
These fields will be returned in addition to the Request Fields; any Continuation Request Fields; any Challenge Response Fields; and the Basic Response Fields.
| Field Name | Returned? | Description |
|---|---|---|
| threeDSEnabled | Always | Is 3DS enabled for this Merchant Account? Possible values are: N – Merchant Account is not enabled. Y – Merchant Account is enabled. |
| threeDSPolicy | If available | 3DS Policy used. Refer to the SCA Using 3-D Secure section for further details. |
| threeDSXID | If 3DS enabled | The unique identifier for the transaction in the 3DS system. |
| threeDSVETimestamp | If 3DS enabled | The time the card was checked for 3DS enrolment, and any initial challenge determined. |
| threeDSEnrolled | If 3DS enabled | The 3DS enrolment status for the credit card. Possible values are: Y – Enrolled. N – Not enrolled. U – Unable to verify if enrolled. E – Error verifying enrolment. |
| threeDSCATimestamp | If 3DS enrolled | The time the last challenge was checked. |
| threeDSAuthenticated | If 3DS enrolled | The 3DS authentication status for the credit card. Possible values are: Y – Authenticated. A – Attempted to authenticate. N – Not authenticated. R – Reject transaction. I – Information only. U – Unable to authenticate. E – Error checking authentication. |
| threeDSECI | If 3DS authenticated | This contains a two-digit Electronic Commerce Indicator (ECI) value. The data contained within this property is only valid if the |
| threeDSCAVV | If 3DS authenticated | This contains a 28-character Base-64 encoded Cardholder Authentication Verification Value (CAVV). The data contained within this property is only valid if the |
| threeDSDetails | If 3DS authenticated | Record containing further details about the 3-D Secure processing stage. Notable sub fields are: · version – 3-D Secure version used · versions – 3-D Secure versions available · psd2Region – whether payment in PSD2 jurisdiction |
| threeDSErrorCode | If 3DS error | Any error response code returned by the ACS if there is an error in determining the card’s 3DS status. |
| threeDSErrorDescription | If 3DS error | Any error response description returned by the ACS if there is an error in determining the card's 3DS status. |
| threeDSResponseCode | Always | A numeric code providing the specific outcome of the 3-D Secure processing stage. Check |
| threeDSResponseMessage | Always | Any error message relating to the outcome of the 3-D Secure processing stage. |
External Authentication Response (Direct Integration)
These fields will be returned in addition to the External Authentication Request Fields and the Basic Response Fields.
| Field Name | Returned? | Description |
|---|---|---|
| threeDSEnabled | Always | Is 3DS enabled for this Merchant Account? Possible values are: N – Merchant Account is not enabled. Y – Merchant Account is enabled. |
If 3-D Secure is not enabled for the Merchant Account, then any 3-D Secure authentication fields sent in the request are ignored and the transaction is processed as normal without 3-D Secure.
Cardholder Information (Hosted and Direct Integration)
In the case of a frictionless flow, the card Issuer may sometimes wish to provide a message to the Cardholder. In this case, the threeDSResponseMessage will start with the text ‘Cardholder Info: ‘ and be followed by the message from the card Issuer.