support
Back to documentation
Search
Categories
Tags
Charge/CreatePayment
webService
Charge/CreatePaymentOrder
webService
Charge/CreateSubscription
webService
Charge/CreateToken
webService
Charge/CreateTokenFromTransaction
webService
Charge/PaymentOrder/Get
webService
Charge/PaymentOrder/Update
webService
Charge/SDKTest
webService
Order/Get
webService
Subscription/Cancel
webService
Subscription/Get
webService
Subscription/Update
webService
Token/Cancel
webService
Token/Get
webService
Token/Reactivate
webService
Token/Update
webService
Transaction/CancelOrRefund
webService
CustomerWallet/Get
webService
CustomerWallet/Update
webService
Transaction/Capture
webService
Transaction/Duplicate
webService
Transaction/Get
webService
Transaction/Update
webService
Transaction/Validate
webService
Risk/AddToGreyList
webService
PCI/Charge/Authenticate (PCI)
PCI
webService
PCI/Charge/CreatePayment (PCI)
PCI
webService
PCI/Charge/CreateToken (PCI)
PCI
webService
Token/Update (PCI)
PCI
webService
PCI/Charge/VerifyPaymentMethod
PCI
webService
AuthenticationResponseData
answer
Charge/PaymentForm
answer
OrderTransactions
answer
Payment
answer
PaymentOrder
answer
Common/ResponseCodeAnswer
answer
Subscription
answer
SubscriptionCreated
answer
Transaction
answer
Token
answer
CustomerWallet
answer
GreyList
answer
Information about the last operationexpand all
id
operationSessionId
value
Protocol information
protocol
name
version
network
challengePreference
simulation
Try me
Documentation

AuthenticationResponseData response

AuthenticationResponseData is the response to the PCI/Charge/Authenticate REST web service.

You can find the reference documentation on its integration here: Cardholder authentication service

Response reference

id

Unique identifier of the authentication, in UUID format.

Format

operationSessionId

Unique identifier of the authentication, in UUID format.

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 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
PROCESOS_DINERS Procesos Diners OTP protocol
OSB Protocol OTP OSB

Format

protocol.simulation

Boolean indicating if the authentication must be carried out in simulation mode. Simulation mode allows to perform merchant integration without being in production or using a real card.

Format

protocol.network

Network where the payment method was authenticated.

Currently supported versions

Value
CB
VISA
MASTERCARD
AMEX_SAFEKEY
ELO
PROCESOS_DINERS
DINERS
DISCOVER
OSB

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

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.

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
N0 Not authenticated
N2 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
xid The field originates from the xid field of the v1 3DS protocol.
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 v1 (xid) string / 28 alphanumeric characters f8e120f1fe934db8b8e58ba4c423db48
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

value.reason.code

Additional code explaining the result. E.g.: DS_TIMEOUT

Format

value.reason.message

Additional message explaining the result.

Format