Retrieve 3DS Result

Retrieves the 3DS Operation identified by the Merchant and the 3DSecureID listed in the URL.

GET https://na.gateway.mastercard.com/api/rest/version/29 / merchant / {merchantId} / 3DSecureId / {3DSecureId}

Authentication Copied to clipboard

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • Basic HTTP authentication as described at w3.org. Provide 'merchant.<your gateway merchant ID>' in the userid portion and your Reporting API password in the password portion.

Request Copied to clipboard

URL Parameters Copied to clipboard

{merchantId} Copied to clipboard Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.


Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40
{3DSecureId} Copied to clipboard ASCII Text REQUIRED

A unique identifier supplied by the merchant for the authentication.


It is first defined in the check3DSEnrollment operation, and then included in subsequent operations.It is not used when the authentication is performed externally.


Data consists of ASCII characters

Min length: 1 Max length: 64

Fields Copied to clipboard

To view the optional fields, please toggle on the "Show optional" setting.

correlationId Copied to clipboard String

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100

Response Copied to clipboard

Fields Copied to clipboard

3DSecure Copied to clipboard ALWAYS PROVIDED

Data representing the 3DS results or enrollment state

3DSecure.acsEci Copied to clipboard Alphanumeric

The Electronic Commerce Indicator returned by the card issuer in the authentication response message.

It indicates the level of security and authentication of the transaction.

Data may consist of the characters 0-9, a-z, A-Z

Min length: 1 Max length: 100
3DSecure.authenticationRedirect Copied to clipboard ALWAYS PROVIDED

A collection of parameters required to build the HTML form that is redirected to the ACS.

There are two options to generate the redirect page used to transfer the cardholder to the card Issuer's Access Control Server (ACS) for authentication:

1. Simple: submit the form generated by the gateway. In this case, only the htmlBodyContent parameter is required.
2. Customized: for those merchants who wish to customise the submission. In this case, the acsURL and paReq parameters will be required to formulate the submission.

3DSecure.authenticationRedirect.customized Copied to clipboard

The customized field is the response returned for those merchants who wish to customise the submission.

In this case, the acsURL and paReq parameters will be required to formulate the submission.

3DSecure.authenticationRedirect.customized.acsUrl Copied to clipboard Url ALWAYS PROVIDED

The URL of the card Issuer's Access Control Server (ACS) where the cardholder can be authenticated.

Ensure that the URL begins with 'https' and is longer than 11 characters.

3DSecure.authenticationRedirect.customized.paReq Copied to clipboard ASCII Text ALWAYS PROVIDED

The Payer Authentication Request (PAReq) message that is sent to the card Issuer's Access Control Server (ACS) to initiate authentication of the cardholder.

It contains all of the information required by the ACS to perform the authentication. PAReq should be sent to the ACS URL unaltered.

Data consists of ASCII characters

Min length: 0 Max length: 4000
3DSecure.authenticationRedirect.simple Copied to clipboard

The simple field is the response returned to those merchants who have chosen the simple option for form submission.

In this case, only the htmlBodyContent parameter is required to formulate the submission.

3DSecure.authenticationRedirect.simple.htmlBodyContent Copied to clipboard String ALWAYS PROVIDED

The generated form to post to the cardholder's browser.

The form will redirect the browser to card Issuer's Access Control Server (ACS) where the cardholder can be authenticated. The form contains all of the information required by the ACS for authentication.

Data can consist of any characters

Min length: 0 Max length: 40960
3DSecure.authenticationToken Copied to clipboard Base64

The base64 encoded value generated by the card issuer.

Included in subsequent transaction request messages and used by the card scheme to verify that the authentication occurred and the values provided are valid. The token should be used unaltered.
This field corresponds to the Cardholder Authentication Verification Value (CAVV) for Visa, the Accountholder Authentication Value (AAV) for MasterCard and JCB, or the American Express Verification Value (AEVV) for American Express.

Data is Base64 encoded

Min length: 28 Max length: 32
3DSecure.summaryStatus Copied to clipboard Enumeration ALWAYS PROVIDED

The summarized response from the card issuer and the payment gateway indicating the overall status of the attempt to authenticate the cardholder.

For detailed information on the authentication result, see gatewayCode.

Value must be a member of the following list. The values are case sensitive.

AUTHENTICATION_ATTEMPTED

Authentication was attempted but the card issuer did not perform the authentication

AUTHENTICATION_FAILED

The cardholder failed the authentication.

AUTHENTICATION_NOT_AVAILABLE

An internal error occurred and Authentication is not currently available.

AUTHENTICATION_SUCCESSFUL

The cardholder was successfully authenticated.

CARD_DOES_NOT_SUPPORT_3DS

The card does not support 3DS authentication.

CARD_ENROLLED

The card is enrolled for 3DS authentication.

CARD_NOT_ENROLLED

The card is not enrolled for 3DS authentication.

3DSecure.xid Copied to clipboard Base64

A unique transaction identifier generated by the Payment Gateway on behalf of the merchant to identify the 3DS transaction.

This field is mandatory for Verified By Visa transactions if authentication was available. The XID should be used in operation requests unaltered.

Data is Base64 encoded

Min length: 28 Max length: 28
3DSecureId Copied to clipboard ASCII Text ALWAYS PROVIDED

A unique identifier supplied by the merchant for the authentication.

It is first defined in the check3DSEnrollment operation, and then included in subsequent operations.
It is not used when the authentication is performed externally.

Data consists of ASCII characters

Min length: 1 Max length: 64
correlationId Copied to clipboard String

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
currencyConversion Copied to clipboard

Information specific to the use of dynamic currency conversion (DCC).

currencyConversion.payerAmount Copied to clipboard Decimal

The total amount of the transaction in the payer's currency.

You must include this field if the payer accepted the DCC offer you presented to them.

Data is a decimal number.

Max value: 1000000000000 Min value: 0 Max post-decimal digits: 3
currencyConversion.payerCurrency Copied to clipboard Upper case alphabetic text

The currency of the DCC rate quote provided by your DCC Service Provider.

The currency must be expressed as an ISO 4217 alpha code, e.g. USD and must be different to that provided for transaction currency. You must include this field if the payer accepted the DCC offer you presented to them.

Data must consist of the characters A-Z

Min length: 3 Max length: 3
currencyConversion.provider Copied to clipboard Enumeration

This identifies the name of the provider of the DCC quote.

This data is for information purposes, and may be useful if you use multiple DCC providers.

Value must be a member of the following list. The values are case sensitive.

FEXCO
TRAVELEX_CURRENCY_SELECT
currencyConversion.providerReceipt Copied to clipboard String

The quote provider's unique reference to the rate quote.

Data can consist of any characters

Min length: 1 Max length: 100
currencyConversion.uptake Copied to clipboard Enumeration ALWAYS PROVIDED

Indicates how DCC applies to the order.

If not provided, this value defaults to NOT_REQUIRED.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

The payer accepted the DCC offer presented to him and will pay in his own currency. The conditions of the quote, as returned in the Retrieve Payment Options response, will be applied in the processing of this transaction.

DECLINED

The payer declined the DCC offer presented to him and will pay in your transaction currency.

NOT_AVAILABLE

A rate quote was requested but no DCC offer was provided (currencyConversion.gatewayCode value other than QUOTE_PROVIDED returned in the Retrieve Payment Options response).

NOT_REQUIRED

DCC not required for this transaction.

merchant Copied to clipboard Alphanumeric + additional characters ALWAYS PROVIDED

The unique identifier issued to you by your payment provider.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 40
response Copied to clipboard ALWAYS PROVIDED

A collection of information that is specific to responses from the API.

response.3DSecure Copied to clipboard ALWAYS PROVIDED

The response code which indicates the status.

response.3DSecure.gatewayCode Copied to clipboard Enumeration ALWAYS PROVIDED

The detailed response from the payment gateway to indicate the status of the 3DS authentication.

The result of a 3DS request to the gateway.

Value must be a member of the following list. The values are case sensitive.

ACS_SESSION_TIMEOUT

The session with the Issuer's ACS timed out. The cardholder did not return from the ACS session.

AUTHENTICATION_ATTEMPTED

The Merchant attempted to authenticate the cardholder with the card Issuer, but the card Issuer did not perform authentication of the card. Proof of authentication attempt was provided.

AUTHENTICATION_FAILED

The cardholder failed authentication by the card Issuer.

AUTHENTICATION_NOT_AVAILABLE_ERROR_DETAILS_PROVIDED

The response received from the card issuer's ACS (PARes) indicated that authentication of the cardholder could not be completed as technical or other issues were encountered by the Issuer's ACS. Error details (IReq) provided.

AUTHENTICATION_NOT_AVAILABLE_NO_ERROR_DETAILS

The response received from the card issuer's ACS (PARes) indicated that authentication of the cardholder could not be completed as technical or other issues were encountered by the Issuer's ACS. No error details (IReq) were provided.

AUTHENTICATION_SUCCESSFUL

The cardholder was successfully authenticated by the card Issuer.

CARD_DOES_NOT_SUPPORT_3DS

The card does not support 3D Secure authentication.

CARD_ENROLLED

Card holder is enrolled.

ENROLLMENT_STATUS_UNDETERMINED_ERROR_DETAILS_PROVIDED

The Issuer's ACS was not able to process the request to check enrollment or the card is ineligible (e.g. it is a Commercial card). The ACS did not provide any further details in the response.

ENROLLMENT_STATUS_UNDETERMINED_NO_ERROR_DETAILS

The Issuer's ACS was not able to process the request to check enrollment or the card is ineligible (e.g. it is a Commercial card). The ACS did not provide any further details in the response.

ERROR_COMMUNICATING_WITH_DIRECTORY_SERVER

An error communicating with the Directory Server was encountered.

ERROR_PARSING_AUTHENTICATION_RESPONSE

Error parsing Payer Authentication Response (PARes) received from the ACS.

ERROR_PARSING_CHECK_ENROLLMENT_REQUEST

Occurs when the request is incorrectly formatted. For example, the Merchant Id is longer than maximum allowed. Will generally only occur as a result of a defect in PS.

ERROR_PARSING_CHECK_ENROLLMENT_RESPONSE

Error parsing Verify Enrollment Response (VERes) received from the ACS.

INVALID_DIRECTORY_SERVER_CREDENTIALS

Merchant ID and Password failed authentication with the Directory Server (Contact Support to rectify)

INVALID_SIGNATURE_ON_AUTHENTICATION_RESPONSE

Error validating signature on response received from the ACS.

MPI_PROCESSING_ERROR

Internal processing error

NOT_ENROLLED_ERROR_DETAILS_PROVIDED

Card holder is not enrolled. Error details were returned by the Directory Server.

NOT_ENROLLED_NO_ERROR_DETAILS

Card holder is not enrolled. No error details were returned by the Directory Server.

Errors Copied to clipboard

error Copied to clipboard

Information on possible error conditions that may occur while processing an operation using the API.

error.cause Copied to clipboard Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

Value must be a member of the following list. The values are case sensitive.

INVALID_REQUEST

The request was rejected because it did not conform to the API protocol.

REQUEST_REJECTED

The request was rejected due to security reasons such as firewall rules, expired certificate, etc.

SERVER_BUSY

The server did not have enough resources to process the request at the moment.

SERVER_FAILED

There was an internal system failure.

error.explanation Copied to clipboard String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field Copied to clipboard String

Indicates the name of the field that failed validation.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode Copied to clipboard String

Indicates the code that helps the support team to quickly identify the exact cause of the error.

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Copied to clipboard Enumeration

Indicates the type of field validation error.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Value must be a member of the following list. The values are case sensitive.

INVALID

The request contained a field with a value that did not pass validation.

MISSING

The request was missing a mandatory field.

UNSUPPORTED

The request contained a field that is unsupported.

result Copied to clipboard Enumeration

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

ERROR

The operation resulted in an error and hence cannot be processed.