AuthenticationResponseData response
The AuthenticationResponseData object is returned by the PCI-DSS services below, when cardholder authentication is required:
PCI/Charge/Authenticate PCI/Authentication/CreateSession PCI/Charge/CreatePayment PCI/Charge/CreateToken PCI/Charge/VerifyPaymentMethod
It may contain:
- either the data required for authenticating the cardholder (AuthenticationInstruction),
- or the authentication result (AuthenticationResult).
Response reference
id
Unique identifier of the authentication, in UUID format.
Format
operationSessionId
Unique identifier for the authentication session.
Format
instructionType
Path: value.instructionType
Type of instruction to carry out.
Format
Possible values
| Values | Description |
|---|---|
| FORM | Form with redirect type instruction. |
value.name
Instruction name.
Possible values
| value | Description |
|---|---|
| CHALLENGE | Challenge Instruction that allows interactive user authentication via the ACS. |
| FINGERPRINT | Fingerprint Instruction that allows to identify the user via the ACS. |
Format
value._type
Type of received response. The interpretation of the rest of the response depends on this attribute.
Possible values
| value | Description |
|---|---|
| AuthenticationInstruction | Instruction type response. |
| AuthenticationResult | Final result type response. |
Format
value.timeout
Maximum response delay when executing an instruction, expressed in seconds. Beyond this delay, it is necessary to initiate the return to the payment gateway server in order to obtain the final result.
Format
value.http.method
Method (verb) used for the request.
Possible values
| value | Description |
|---|---|
| DELETE | Delete method |
| GET | Get method |
| PATCH | Patch method |
| POST | Post method |
| PUT | Put method |
Format
value.http.url
URL to which the HTTP form must be submitted.
Format
value.http.body
List of request body parameters, presented as “name”: “value”.
Format
value.http.headers
List of HTTP request headers, presented as “name”: “value”.
Format
value.target.element
Type of the target HTML element which contains the instruction.
Possible values
| value | Description |
|---|---|
| IFRAME |
Format
value.target.height
Height of the HTML target in pixels.
Format
value.target.visible
Boolean indicating whether or not the HTML target must be visible.
Format
value.target.width
Width of the HTML target in pixels.
Format
value.target.showUrl
Technical field for internal use that allows to show or hide the URL of the ACS.
Format
challengePreference
Path: protocol.challengePreference
Indicates whether or not the merchant has requested a challenge.
Possible values
| Values | Description |
|---|---|
| NO_PREFERENCE | No particular preference. |
| NO_CHALLENGE_REQUESTED | Challenge is not explicitly requested. |
| CHALLENGE_REQUESTED | Challenge is requested by the Merchant. |
Format
protocol.name
Name of the protocol used by the cardholder authentication services.
Possible values
| value | Description |
|---|---|
| THREEDS | 3D Secure protocol |
Format
protocol.simulation
Boolean that indicates if the authentication must be done in simulation mode. If you set this mandatory field to:
true, you activate the simulation mode.false, you do not enable the simulation mode.
This mode allows you to perform a merchant integration without being in production mode, and without using real cards.
Format
protocol.network
Network where the payment method was authenticated.
Currently supported networks
| value |
|---|
| CB |
| VISA |
| MASTERCARD |
| AMEX_SAFEKEY |
| PROTECTBUY |
Format
protocol.version
Version of the protocol used by the cardholder authentication services.
Currently supported versions
| value | Description |
|---|---|
| 1.0.2 | Version 1.0.2 |
| 2.1.0 | Version 2.1.0 |
| 2.2.0 | Version 2.2.0 |
Format
authenticationType
Path: value.authenticationType
Type of authentication that has been applied.
Possible values
| value | Description |
|---|---|
| FRICTIONLESS | Authentication in Frictionless mode, i.e. transparent for the Buyer. |
| CHALLENGE | Authentication with a Challenge, the Buyer had to explicitly authenticate him/herself via the ACS. |
| DATA_ONLY | Authentication processed by the DS without client interaction |
Format
commerceIndicator
Path: value.commerceIndicator
Commerce Indicator, or ECI (Electronic Commerce Indicator) for the 3DS protocol. Indicator returned by the ACS to report the results of cardholder’s authentication attempt.
In case of authentication without payment (e.g. in case of card registration) MasterCard can return the following 2 values:
| value | Description |
|---|---|
| Not authenticated | |
| Authenticated |
Format
value.status
Authentication status, i.e. the positive/negative outcome of the authentication.
Possible values
| value | Description |
|---|---|
| ATTEMPT | Proof of authentication attempt when authentication is not available. |
| ENROLLED_UNAVAILABLE | Unable to assess the enrollment status. |
| FAILED | Authentication error |
| NOT_ENROLLED | Card not enrolled. |
| SUCCESS | Successful authentication. |
| UNAVAILABLE | The authentication could not be completed (technical error, etc.). |
| DISABLED | Authentication disabling requested. |
| REJECTED | Authentication rejected by the ACS. |
Format
authenticationIdType
Path: value.authenticationId.authenticationIdType
Type of authentication that has been applied.
Possible values
| value | Description |
|---|---|
| dsTransId | The field originates from the dsTransId field of the v2 3DS protocol. |
Format
value
Path: value.authenticationId.value
Value of the authentication transaction identifier known to the banking network.
The length of the field varies depending on the authentication protocol.
| PROTOCOL | Format / Length | value Example: |
|---|---|---|
| 3DS v2 (dsTransId) | string / 32 alphanumeric characters + 4 dashes | 4317fdc3-ad24-5443-8000-000000000891 |
Format
authenticationValueType
Path: value.authenticationValue.authenticationValueType
Type of authentication value.
Possible values
| value | Description |
|---|---|
| AEVV | American Express Verification Value (used by Amex). |
| CAVV | Cardholder Authentication Verification Value (used by VISA). |
| AAV | Accountholder Authentication Value (used by Mastercard). |
Format
value
Path: value.authenticationValue.value
Final authentication value (depending on the DS this value can be called CAVV, AEVV or AAV). Character string encoded in base64 with a size of 28 characters.
Format
authenticationType
Path: value.extension.authenticationType
Type of result extension.
Format
Possible values
| Values | Description |
|---|---|
| THREEDS_V2 | Extension for 3DS Secure v2 authentications |
acsTransId
Path: value.extension.acsTransId
ACS transaction ID. This field is only relevant to the CB network. See: Integration Guide
Format
cbScore
Path: value.extension.cbScore
CB score as defined in the CB extension of the ARES message.
Format
algorithm
Path: value.extension.algorithm
Code of the algorithm used for generating the Authentication Value (used during the authorization).
Possible values
| value | Description |
|---|---|
| 0 | |
| 1 | |
| 2 | CVV with ATN |
| 3 | MasterCard SPA |
Format
value.reason.code
Additional code explaining the result. E.g.: DS_TIMEOUT.
Format
value.reason.message
Additional message explaining the result.