This guide provides information for using 3-D Secure 2 with the BlueSnap API.

For general information about 3-D Secure and 3-D Secure 2, refer to the 3-D Secure Guide.
For answers to specific questions related to BlueSnap and 3-D Secure 2, PSD2, and SCA, refer to our 3-D Secure 2 FAQs page.
If you're using Client-Side Encryption, please follow the instructions here to implement 3-D Secure.

This guide provides the following information:

3-D Secure in Hosted Payment Fields
3-D Secure with Plain Text cards
3-D Secure with Returning Shoppers
3-D Secure in Payment Request API (W3C)
3-D Secure in Secured Payment Collector
Processing payments with data from external Merchant Plug-In (MPI)
Supported 3-D Secure object properties
Error codes
Authentication results

👍
Note
You don't have to apply 3-D Secure to all transactions. If you want to apply 3DS only to EU-issued cards for PSD2, but not US-issued cards, you can do that. Refer to Step 5 for examples.

🚧
Important
Since 3-D Secure uses URLs that vary based on the credit card issuer, the Content-Security-Policy (CSP) should be as permissive as possible and leverage the ‘*’ (wildcard) token. Any other CSP will likely result in a failure.
Merchant-initiated transactions are out of scope for 3-D Secure, provided they follow a 3-D Secure Customer Initiated Transaction (learn more). To make sure your transaction is identified as merchant-initiated, you must use the Merchant Managed Subscription API. Refer to Create Merchant-Managed Subscription and Create Merchant-Managed Subscription Charge for details.
BlueSnap applies this out-of-scope exemption to applicable transactions only for merchants who are using the BlueSnap Subscription Engine or our Merchant Managed Subscription feature. If you handle your own subscriptions (that is, you are sending straight auth‑capture requests not using the BlueSnap Subscription Engine or our merchant-managed subscription feature), follow the information in the Rules for MITs for more information.

Before you begin

If applicable, make sure you've implemented the latest version of Hosted Payment Fields.

Enable 3-D Secure
To get started, contact Merchant Support to request that BlueSnap enable 3DS for your account. After it has been enabled, you can activate it in your Merchant Portal by going to Settings > Fraud Settings and selecting Enable 3D Secure.
Enable IPNs for your account. When the shopper's account is debited for the transaction, the Charge IPN is sent with the 3DStatus parameter, which verifies the 3-D Secure result.

3-D Secure in Hosted Payment Fields

If you're using Hosted Payment Fields, implementing 3DS consists of these steps:

Step 1: Prevent your shopper from submitting the form during 3-D Secure setup
Step 2: Enable 3-D Secure usage in the transaction
Step 3: Account for 3-D Secure errors
Step 4: Create 3-D Secure object with transaction data
Step 5: Determine 3-D Secure result
Step 6: Process the transaction with Hosted Payment Fields token

Step 1: Prevent your shopper from submitting the form during 3-D Secure setup

If the shopper submits the payment form while BlueSnap is setting up 3DS, an error may occur. You must let BlueSnap deactivate the submit button while setting up 3DS. To do this, add the data-bluesnap attribute to your submit button element and set the value to submitButton, as shown here

<button data-bluesnap="submitButton" type="submit" id="submit-button">Pay Now</button>

🚧
Important!
You must define the data-bluesnap value exactly as shown above; otherwise, BlueSnap cannot properly deactivate the button.

Step 2: Enable 3-D Secure usage in the transaction

Enable 3DS usage in the transaction by adding the property '3DS' to bsObj and set its value to true.

var bsObj = {
  ... 
  '3DS': true
};

Step 3: Account for 3-D Secure errors

BlueSnap passes 3DS error codes and descriptions (shown here) to your onError callback function as the errorCode and errorDescription parameters. Update your onError callback function to account for these errors.

Step 4: Create 3-D Secure object with transaction data

Create a 3DS object with at least the transaction amount and currency, as shown in the code below.
If you want to submit the credentials and activate 3DS, pass your object as an additional parameter to bluesnap.hostedPaymentFieldsSubmitData (shown in Step 5). You can also decide not to activate 3DS and not pass the object.

When the shopper hits the submit button, the data you provide within your object is sent to the issuer during the lookup and they decide if shopper authentication is required. In some cases, the issuer may authenticate the transaction (and assume fraud chargeback liability) without requiring the shopper to enter their credentials in the popup screen, making the 3DS flow entirely transparent.

👍
Provide as much transaction data as possible
Provide as much transaction data as possible to improve the issuer's ability to authenticate the transaction without requiring the shopper to enter their credentials during checkout (refer to Supported 3-D Secure object properties).

var threeDSecureObj = {
  amount: 35.75, 
  currency: 'USD'
  ...
};

Step 5: Determine 3-D Secure result

BlueSnap passes the 3DS result to your purchase function callback as callBack.threeDSecure.authResult, which has one of the values shown here. Configure your purchase function callback to determine the 3DS result and take appropriate action. (Refer to the code below for a simple bluesnap.hostedPaymentFieldsSubmitData call with the changes from Steps 4 and 5.)

👍
Note
callBack.threeDSecure also includes threeDSecureReferenceId, a reference to the 3DS authentication.

The code calls bluesnap.hostedPaymentFieldsSubmitData with a simple purchase callback function. Here you can decide if you want to activate 3DS by either including the threeDSecureObj in bluesnap.hostedPaymentFieldsSubmitData or you can decide not to activate 3DS and not pass the object.

bluesnap.hostedPaymentFieldsSubmitData(function(callback) {
        if (null != callback.cardData) {
                console.log('Card type is ' + callback.cardData.ccType +
               ', Last 4 digits are ' + callback.cardData.last4Digits +
               ', Exp is ' + callback.cardData.exp + 
               ', Issuing Country is ' + callback.cardData.issuingCountry + 
               ', 3D Secure result is ' + (callback.threeDSecure != null ? callback.threeDSecure.authResult : null));
               // submit form to server & process transaction
        } else {
               .
               .
               .
        }
}, threeDSecureObj);

bluesnap.hostedPaymentFieldsSubmitData(function(callback) {
        if (null != callback.cardData) {
                console.log('Card type is ' + callback.cardData.ccType +
               ', Last 4 digits are ' + callback.cardData.last4Digits +
               ', Exp is ' + callback.cardData.exp + 
               ', Issuing Country is ' + callback.cardData.issuingCountry + 
               ', 3D Secure result is ' + (callback.threeDSecure != null ? callback.threeDSecure.authResult : null));
               // submit form to server & process transaction
        } else {
               .
               .
               .
        }
});

Step 6: Process the transaction with Hosted Payment Fields token

Process 3-D Secure transactions (or save shopper payment details) from your server the same way you handle regular card payments—by including your token within the pfToken property in the request. Refer to the Hosted Payment Fields guide for Payment API code samples with pfToken.

3-D Secure with Plain Text cards

If you're using plain text cards, implementing 3-D Secure consists of these steps:

Step 1: Obtain the 3DS Payments token for the session
Step 2: Add the BlueSnap JavaScript file to your checkout form
Step 3: Initialize 3DS
Step 4: Activate 3DS Payments Submit Data function
Step 5: Process a transaction with the 3DS Reference ID

Step 1: Obtain the 3DS Payments token for the session

Get your 3DS Payments token by sending a server-to-server POST request.

For a card that is new on your website:
Production: https://ws.bluesnap.com/services/2/payment-fields-tokens
Sandbox: https://sandbox.bluesnap.com/services/2/payment-fields-tokens
For a saved card:
Production: https://ws.bluesnap.com/services/2/payment-fields-tokens/prefill
Sandbox: https://sandbox.bluesnap.com/services/2/payment-fields-tokens/prefill
{ "ccNumber":"4111 1111 1111 1111", "expDate" : "01/2022" }

The response provides the token in the location header. For example:
Production: https://ws.bluesnap.com/services/2/payment-fields-tokens/PAYMENTFIELDTOKENID
Sandbox: https://sandbox.bluesnap.com/services/2/payment-fields-tokens/PAYMENTFIELDTOKENID

Note: Secured Payments Token expires after 60 minutes.

📘
Insert the domain for either Sandbox or Production
In all steps, replace the BLUESNAPDOMAINPATH with the relevant domain for either the BlueSnap Sandbox or Production environment, as follows:

Sandbox: https://sandpay.bluesnap.com

Production: https://pay.bluesnap.com

For example, the Hosted Fields token request (step 1) should be sent to https://sandpay.bluesnap.com/services/2/payment-fields-tokens on Sandbox and https://pay.bluesnap.com/services/2/payment-fields-tokens on Production.

Step 2: Add the BlueSnap JavaScript file to your checkout form

In your checkout page, call the BlueSnap JavaScript file by adding the following script:

<script type="text/javascript" src="BLUESNAPDOMAINPATH/web-sdk/5/bluesnap.js"></script>

Step 3: Initialize 3DS

To initialize 3-D Secure, call bluesnap.threeDsPaymentsSetup with the following parameters:

The token from step 1
A callback function to handle the data submission results (this occurs in step 4)

<script>
    //Run the following command after Document Object Model (DOM) is fully loaded
    // and bluesnap script was loaded 
    bluesnap.threeDsPaymentsSetup("PAYMENTFIELDTOKENID", function(sdkResponse){
    	var code = sdkResponse.code;
    	if (code == 1){  // on Success
	        var cardData = sdkResponse.cardData;
	        var threeDSecure = sdkResponse.threeDSecure;
                    console.log('card type: ' + cardData.ccType
                    + ', last4digits: '
                    + cardData.last4Digits
                    + ', issuing Country: '
                    + cardData.issuingCountry
                    + ', is Regulated Card: '
                    + cardData.isRegulatedCard
                    + ', card Sub Type: '
                    + cardData.cardSubType
                    + ', bin Category: '
                    + cardData.binCategory
                    + ', cc bin: '
                    + cardData.ccBin
                    + ', 3D Secure result: '
                    + threeDSecure.authResult
                    + ', 3D Secure ReferenceId: '
                    + threeDSecure.threeDSecureReferenceId
                    + ', after that I can call final submit');
                    // SUBMIT THE FORM HERE!
        } else {
                // in case some errors occurred 
                var errorsArray = sdkResponse.info.errors;
                // in case some warnings occurred
                var warningsArray = sdkResponse.info.warnings;
        }
    });
</script>

Replace PAYMENTFIELDTOKENID with the token you obtained in Step 1.

The SdkResponse object contains:

{
  "status": STATUS,
  "code": ERROR_CODE,
  "info": {   // if an error or warning occurred
     "errors": ["Some errors"],
     "warnings": ['Some warning']
   },
  "cardData": {
    "binCategory": "CONSUMER",
    "ccBin": "411111",
    "cardSubType": "CREDIT",
    "ccType": "VISA",
    "last4Digits": "0002",
    "isRegulatedCard": "Y",
    "issuingCountry": "us"
  },
  "threeDSecure": {
    "authResult": “AUTHENTICATION_SUCCEEDED”,
    "threeDSecureReferenceId": "12345"
  }
}

The "status" can have the following values:

Success
Invalid Data — Identifies issues with the jsonData provided from the merchant.
Inner Error — Identifies issues in the solution itself.
Server Error — Identifies issues with the BlueSnap server.

The "code" field can have the following error codes:

1 — On a status of Success
10 — On a status of Invalid Data when an error prevents the process from continuing. For example: Invalid provided currency.
15 — On a status of Invalid Data when an error does not prevent the process from continuing. (The callback is called with a warning array. The process continues and callback is called again on completion or another error). For example: Invalid billingFirstName.
Other codes are the BlueSnap server HTTP errors or generic server errors (400, 500). For example:
- 22013 is CC_TYPE_IS_NOT_SUPPORTED_BY_THE_MERCHANT
- 14040 is TOKEN_IS_EXPIRED
- 14042 is TOKEN_IS_NOT_ASSOCIATED_WITH_A_PAYMENT_METHOD
- 14104 is SHOPPER_CC_NOT_FOUND
- 14102/10 is THREE_D_SECURE_MISSING_REQUIRED_FIELDS

The "info" field is present if an error or warning occurred and will contain the errors and warnings.

The following are possible values for errors:
- Invalid amount: <given_amount> — An invalid amount was given
- Amount is mandatory and must be of type number — An amount wasn’t provided or provided not as a number
- Currency <given_currency> is not supported — The given currency is not supported
- Currency is mandatory — An amount wasn’t provided
- Invalid ccNumber
- Invalid cvv
- Invalid expDate
- Invalid ccType
- Invalid last4Digits
The following is a possible value for warnings:
- Parameter <given_key> with value of <given_value> is invalid — Keys verified through this process are: email, all shipping details, and all of the billing details.
  For example: Parameter shippingFirstName with value of 123 is invalid

Step 4: Activate 3DS Payments Submit Data function

To activate 3DS Payments Submit Data function when the user presses the submit button and then wait for response before activating the submit form, add the script below into your checkout form:

<script>
	var newCard = {
		"ccNumber":"CREDIT CARD NUMBER",
		"cvv":"CVV", //Optional
		"expDate":"MM/YYYY",
		"amount": 10,
		"currency": "USD"
	}
	bluesnap.threeDsPaymentsSubmitData(newCard);
</script>

<script>
	var saveCardDirectly = {
		"cvv":"CVV",  //Optional
		"amount": 10,
		"currency": "USD"
	}
	bluesnap.threeDsPaymentsSubmitData(saveCardDirectly);
</script>

This function should be activated when the shopper clicks the Submit button. This submits the credit card data to BlueSnap, where it is associated with the 3DS Payments Token. After the data submission is completed, BlueSnap calls your function from step 3 with the submission results.

Step 5: Process a transaction with the 3DS Reference ID

Process 3-D Secure transactions (or save shopper payment details) from your server the same way you handle regular card payments—by including the threeDSecureReferenceId within the threeDSecure property in the request. Refer to the Auth-Capture section for Payment API code samples with 3-D Secure.

curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "cardTransactionType": "AUTH_CAPTURE",
  "recurringTransaction": "ECOMMERCE",
  "softDescriptor": "DescTest",
  "amount": 10,
  "currency": "USD",
  "cardHolderInfo": {
    "firstName": "Will",
    "lastName": "Smith"
  },
  "creditCard": {
    "cardNumber": "4012000033330026",
    "securityCode": "123",
    "expirationMonth": "07",
    "expirationYear":"2019"
  },
  "threeDSecure": {
  	"threeDSecureReferenceId":"4759"
  }
}'

# 3-D Secure with Returning Shoppers If you're using 3-D Secure for returning shoppers, implementation consists of these steps:

Step 1: Obtain the 3DS Payments token for this session
Step 2: Add the BlueSnap JavaScript file to your checkout page
Step 3: Initialize 3DS
Step 4: Activate 3DS Payments Submit Data function
Step 5: Process the transaction with the 3DS Reference ID

Step 1: Obtain the 3DS Payments token for this session

Get your 3DS Payments token by sending a server-to-server POST request to:

BLUESNAPDOMAINPATH/services/2/payment-fields-tokens?shopperId=SHOPPERID

If you have saved the shopper using your sellerShopperId, you can use that instead of shopperId.

The response provides the token in the location header. For example:
BLUESNAPDOMAINPATH/services/2/payment-fields-tokens/PAYMENTFIELDTOKENID

📘
Insert the domain for either Sandbox or Production
In all steps, replace the BLUESNAPDOMAINPATH with the relevant domain for either the BlueSnap Sandbox or Production environment, as follows:

Sandbox: https://sandbox.bluesnap.com

Production: https://ws.bluesnap.com

For example, the Hosted Fields token request (step 1) should be sent to https://sandbox.bluesnap.com/services/2/payment-fields-tokens on Sandbox and https://ws.bluesnap.com/services/2/payment-fields-tokens on Production.

Note: Secured Payments Token expires after 60 minutes.

Step 2: Add the BlueSnap JavaScript file to your checkout page

In your checkout page, call the BlueSnap JavaScript file by adding the following script:

<script type="text/javascript" src="BLUESNAPDOMAINPATH/web-sdk/4/bluesnap.js"></script>

Step 3: Initialize 3DS

To initialize 3-D Secure, call bluesnap.threeDsPaymentsSetup with the following parameters:

The token from step 1
A callback function to handle the data submission results (this occurs in step 4)

<script>
    //Run the following command after Document Object Model (DOM) is fully loaded
    // and bluesnap script was loaded 
    bluesnap.threeDsPaymentsSetup("PAYMENTFIELDTOKENID", function(sdkResponse){
    	var code = sdkResponse.code;
    	if (code == 1){  // on Success
	        var cardData = sdkResponse.cardData;
	        var threeDSecure = sdkResponse.threeDSecure;
                    console.log('card type: ' + cardData.ccType
                    + ', last4digits: '
                    + cardData.last4Digits
                    + ', issuing Country: '
                    + cardData.issuingCountry
                    + ', is Regulated Card: '
                    + cardData.isRegulatedCard
                    + ', card Sub Type: '
                    + cardData.cardSubType
                    + ', bin Category: '
                    + cardData.binCategory
                    + ', cc bin: '
                    + cardData.ccBin
                    + ', 3D Secure result: '
                    + threeDSecure.authResult
                    + ', 3D Secure ReferenceId: '
                    + threeDSecure.threeDSecureReferenceId
                    + ', after that I can call final submit');
                    // SUBMIT THE FORM HERE!
        } else {
                // in case some errors occurred 
                var errorsArray = sdkResponse.info.errors;
                // in case some warnings occurred
                var warningsArray = sdkResponse.info.warnings;
        }
    });
</script>

Replace PAYMENTFIELDTOKENID with the token you obtained in Step 1.

The SdkResponse object contains:

{
  "status": STATUS,
  "code": ERROR_CODE,
  "info": {   // if an error or warning occurred
     "errors": ["Some errors"],
     "warnings": ['Some warning']
   },
  "cardData": {
    "binCategory": "CONSUMER",
    "ccBin": "411111",
    "cardSubType": "CREDIT",
    "ccType": "VISA",
    "last4Digits": "0002",
    "isRegulatedCard": "Y",
    "issuingCountry": "us"
  },
  "threeDSecure": {
    "authResult": “AUTHENTICATION_SUCCEEDED”,
    "threeDSecureReferenceId": "12345"
  }
}

The "status" can have the following values:

Success
Invalid Data — Identifies issues with the jsonData provided from the merchant.
Inner Error — Identifies issues in the solution itself.
Server Error — Identifies issues with the BlueSnap server.

The "code" field can have the following error codes:

1 — On a status of Success
10 — On a status of Invalid Data when an error prevents the process from continuing. For example: Invalid provided currency.
15 — On a status of Invalid Data when an error does not prevent the process from continuing. (The callback is called with a warning array. The process continues and callback is called again on completion or another error). For example: Invalid billingFirstName.
Other codes are the BlueSnap server HTTP errors or generic server errors (400, 500). For example:
- 22013 is CC_TYPE_IS_NOT_SUPPORTED_BY_THE_MERCHANT
- 14040 is TOKEN_IS_EXPIRED
- 14042 is TOKEN_IS_NOT_ASSOCIATED_WITH_A_PAYMENT_METHOD
- 14104 is SHOPPER_CC_NOT_FOUND
- 14102/10 is THREE_D_SECURE_MISSING_REQUIRED_FIELDS

The info field is present if an error or warning occurred and will contain the errors and warnings.

Step 4: Activate the 3DS Payments Submit Data function

To activate 3DS Payments Submit Data function when the user presses the submit button and then wait for response before activating the submit form, add the script below into your checkout form:

<script>
	var previouslyUsedCard = {
		"last4Digits": "1111",
		"ccType": "VISA",
		"amount": 10,
		"currency": "USD"
	}
  bluesnap.threeDsPaymentsSubmitData(previouslyUsedCard);
</script>

Step 5: Process the transaction with the 3DS Reference ID

curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
	"cardTransactionType": "AUTH_CAPTURE",
	"softDescriptor": "DescTest",
	"amount": 10,
	"currency": "USD",
	"vaultedShopperId":"19574268",
	"creditCard": {
		"cardLastFourDigits": "1111",
		"cardType": "VISA"
		},
	"threeDSecure": {
		"threeDSecureReferenceId":"5303"
	}
}'

3-D Secure in Payment Request API (W3C)

To add 3-D Secure to Payment Request API (W3C), add "threeDS": "true" in the sdkRequest object. For more information, refer here.

3-D Secure in Secured Payment Collector

To add 3-D Secure to the Secured Payment Collector, pass true to bluesnap.securedPaymentCollectorSetup (Step 4 of the implementation process).

To process the transaction with 3-D Secure, send the value from sdkResponse.threeDSecure.authResult (Step 4 of the implementation process) to your server. Include this value and your token in your API request to BlueSnap. For example:

curl -v -X POST https://sandbox.bluesnap.com/services/2/transactions \
   -H 'Content-Type: application/json' \
   -H 'Accept: application/json' \ 
   -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
   -d '
{
  "cardTransactionType": "AUTH_CAPTURE",
  "amount": 25.0,
  "currency": "USD",
  "pfToken": "PAYMENT_TOKEN",
  "threeDSecure": {
    "threeDSecureReferenceId": "1234"
  }
}'

To process the transaction without 3-D Secure, omit the threeDSecure object from the request. For details, see Completing Tokenized Payments.

Processing payments with data from external Merchant Plug-In (MPI)

If you're using an external Merchant Plug-In (MPI) for 3-D Secure and you only want to process the payment through BlueSnap, first contact Merchant Support and inform them you're using an external MPI so that your account can be configured appropriately.

📘
Note
If you’re using an external merchant plugin you don’t need to set the flag in BlueSnap.
Ask your implementation manager to provide the appropriate MIDs and BINs.

To process the payment, include the threeDSecure object.

Sample Auth Capture request:

{
  "amount": 11,
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name", 
    "zip": "123456"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": 2019,
    "securityCode": 111,
    "expirationMonth": "07",
    "cardNumber": 4012000033330026
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "threeDSecure": {
    "eci": "05",
    "cavv": "AAABAWFlmQAAAABjRWWZEEFgFz+A",
    "xid": "MGpHWm5ZWVpKclo0aUk0VmltVDA=",
     "dsTransactionId" : "e08da266-b58d-45c9-a1f8-570b7fb80e30",
     "threeDSecureVersion" : "2.1.0"
  }
}

Supported 3-D Secure object properties

amount     number    required
currency     string    required
billingFirstName     string    optional
billingLastName     string    optional
billingCountry     string    optional   Value must be a two-letter country code (ISO 3166-1 alpha-2). Find a complete list of country codes here.
billingState     string
  optional   Value must be the state/province portion of the ISO 3166-2 code, in all uppercase characters. For example, for US-OH, send OH, or for GB-LND, send LND. If you are uncertain of the format, it is recommended to not pass a value.
billingCity     string    optional
billingAddress     string    optional
billingZip     string    optional
shippingFirstName     string    optional
shippingLastName     string    optional
shippingCountry     string    optional
  optional   Value must be a two-letter country code (ISO 3166-1 alpha-2). Find a complete list of country codes here.
shippingState     string    optional
  optional   Value must be the state/province portion of the ISO 3166-2 code, in all uppercase characters. For example, for US-OH, send OH, or for GB-LND, send LND. If you are uncertain of the format, it is recommended to not pass a value.
shippingCity     string    optional
shippingAddress     string    optional
shippingZip     string    optional
email     string    optional
phone     string    optional

Error codes

Error Code	Description
`14100`	Problem: 3-D Secure is not enabled Resolution: Enable 3-D Secure
`14101`	Problem: 3-D Secure authentication failed Resolution: Inform the shopper to try a different payment method
`14102/10`	Problem: 3-D Secure object is missing required fields { ... } Resolution: Make sure 3-D Secure object has both transaction amount and currency
`14103`	Problem: 3-D Secure client error Resolution: Continue without 3DS

Authentication results

`AUTHENTICATION_BYPASSED`###

Meaning: 3-D Secure authentication was bypassed due to the merchant's configuration or the shopper’s credit card issuing bank configuration.
To Proceed: Process the transaction without 3-D Secure
- in Hosted Payment Fields
- in the Secured Payment Collector

`AUTHENTICATION_SUCCEEDED`###

Meaning: 3-D Secure authentication was successful because the shopper entered their credentials correctly or the issuer authenticated the transaction without requiring shopper identity verification. This transaction is eligible for a 3-D Secure chargeback liability shift.
To Proceed:
- In Hosted Payment Fields: Process the 3-D Secure transaction
- In the Secured Payment Collector: Process the 3-D Secure transaction

`AUTHENTICATION_UNAVAILABLE`###

Meaning: 3-D Secure is unavailable for this card or a technical error occurred.
To Proceed: Process the transaction without 3-D Secure
- in Hosted Payment Fields
- in the Secured Payment Collector

`AUTHENTICATION_FAILED`###

Meaning: The card on the transaction could not be authenticated..
To Proceed: If the option Process failed 3DS transactions is enabled in Settings > Fraud Settings in the Merchant Portal, then the transaction can be processed.

📘
Note
The authentication result above is included in the Order Locator information for any order processed using 3-D Secure.

# Testing 3-D Secure For information about Sandbox testing of 3-D Secure, refer [here](https://support.bluesnap.com/docs/3d-secure#section-sandbox-testing-of-3-d-secure).

Subscribing to Events

BlueSnap uses an event-based system that helps you get insight into what’s happening in real-time. It allows you to subscribe to different events that are triggered internally by BlueSnap. You only have to subscribe to an event once per page load. After that, you won't need to re-subscribe.

Keep in mind you should subscribe to events before you call the bluesnap.threeDsPaymentsSetup function. The code snippets below are currently only applicable to 3DS with plain text cards and with returning shoppers.

bluesnap.on('setupComplete', () => {

// setupComplete

});

bluesnap.on('threeDsChallengeExecuted', () => {

// threeDsChallengeExecuted

});

3-D Secure for API

👍
Note

🚧
Important

Before you begin

3-D Secure in Hosted Payment Fields

Step 1: Prevent your shopper from submitting the form during 3-D Secure setup

🚧
Important!

Step 2: Enable 3-D Secure usage in the transaction

Step 3: Account for 3-D Secure errors

Step 4: Create 3-D Secure object with transaction data

👍
Provide as much transaction data as possible

Step 5: Determine 3-D Secure result

👍
Note

Step 6: Process the transaction with Hosted Payment Fields token

3-D Secure with Plain Text cards

Step 1: Obtain the 3DS Payments token for the session

📘
Insert the domain for either Sandbox or Production

Step 2: Add the BlueSnap JavaScript file to your checkout form

Step 3: Initialize 3DS

Step 4: Activate 3DS Payments Submit Data function

Step 5: Process a transaction with the 3DS Reference ID

Step 1: Obtain the 3DS Payments token for this session

📘
Insert the domain for either Sandbox or Production

Step 2: Add the BlueSnap JavaScript file to your checkout page

Step 3: Initialize 3DS

Step 4: Activate the 3DS Payments Submit Data function

Step 5: Process the transaction with the 3DS Reference ID

3-D Secure in Payment Request API (W3C)

3-D Secure in Secured Payment Collector

Processing payments with data from external Merchant Plug-In (MPI)

📘
Note

Supported 3-D Secure object properties

Error codes

Authentication results

`AUTHENTICATION_BYPASSED`###

`AUTHENTICATION_SUCCEEDED`###

`AUTHENTICATION_UNAVAILABLE`###

`AUTHENTICATION_FAILED`###

📘
Note

Subscribing to Events

👍Note

🚧Important

Before you begin

3-D Secure in Hosted Payment Fields

Step 1: Prevent your shopper from submitting the form during 3-D Secure setup

🚧Important!

Step 2: Enable 3-D Secure usage in the transaction

Step 3: Account for 3-D Secure errors

Step 4: Create 3-D Secure object with transaction data

👍Provide as much transaction data as possible

Step 5: Determine 3-D Secure result

👍Note

Step 6: Process the transaction with Hosted Payment Fields token

3-D Secure with Plain Text cards

Step 1: Obtain the 3DS Payments token for the session

📘Insert the domain for either Sandbox or Production

Step 2: Add the BlueSnap JavaScript file to your checkout form

Step 3: Initialize 3DS

Step 4: Activate 3DS Payments Submit Data function

Step 5: Process a transaction with the 3DS Reference ID

Step 1: Obtain the 3DS Payments token for this session

📘Insert the domain for either Sandbox or Production

Step 2: Add the BlueSnap JavaScript file to your checkout page

Step 3: Initialize 3DS

Step 4: Activate the 3DS Payments Submit Data function

Step 5: Process the transaction with the 3DS Reference ID

3-D Secure in Payment Request API (W3C)

3-D Secure in Secured Payment Collector

Processing payments with data from external Merchant Plug-In (MPI)

📘Note

Supported 3-D Secure object properties

Error codes

Authentication results

AUTHENTICATION_BYPASSED###

AUTHENTICATION_SUCCEEDED###

AUTHENTICATION_UNAVAILABLE###

AUTHENTICATION_FAILED###

📘Note

Subscribing to Events

👍
Note

🚧
Important

🚧
Important!

👍
Provide as much transaction data as possible

👍
Note

📘
Insert the domain for either Sandbox or Production

📘
Insert the domain for either Sandbox or Production

📘
Note

`AUTHENTICATION_BYPASSED`###

`AUTHENTICATION_SUCCEEDED`###

`AUTHENTICATION_UNAVAILABLE`###

`AUTHENTICATION_FAILED`###

📘
Note