{"_id":"5ce584f4d4dfa6001f41c69a","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5c6c238ff7d54800395355a0","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5beb278ac442ab0213f009cf","createdAt":"2018-04-23T14:36:48.535Z","releaseDate":"2018-04-23T14:36:48.535Z","categories":["5c6c238ff7d548003953555d","5c6c238ff7d548003953555e","5c6c238ff7d548003953555f","5c6c238ff7d5480039535560","5c6c238ff7d5480039535561","5c6c238ff7d5480039535562","5beb278ac442ab0213f00990","5c6c238ff7d5480039535563","5c3f542c12c4ac004bc51718","5c928dba4aa821001ae4f050"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Main","version_clean":"8976.0.0-Basics","version":"8976-Basics"},"category":{"_id":"5c6c238ff7d5480039535563","version":"5c6c238ff7d54800395355a0","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-03T20:45:01.593Z","from_sync":false,"order":7,"slug":"topics","title":"Guides"},"user":"5beb1b96bc2003003ecd645e","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-22T17:20:52.790Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"This guide provides information for using 3-D Secure 2.0 with the BlueSnap API.  \n* For general information about 3-D Secure and 3-D Secure 2.0, refer to the [3-D Secure Guide](https://support.bluesnap.com/docs/3d-secure).\n* For answers to specific questions related to BlueSnap and 3-D Secure 2.0, PSD2, and SCA, refer to [our 3-D Secure 2.0 FAQs page](https://support.bluesnap.com/docs/3ds2-faqs). \n\nThis guide provides the following information:\n* [3-D Secure in Hosted Payment Fields](#section-3-d-secure-in-hosted-payment-fields)\n* [3-D Secure in Client-Side Encryption](#section-3-d-secure-in-client-side-encryption)\n* [Processing payments with data from external Merchant Plug-In (MPI)](#section-processing-payments-with-data-from-external-merchant-plug-in-mpi-)\n* [Error codes](#section-error-codes)\n* [Authentication results](#section-authentication-results)\n\n<hr />\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Note\",\n  \"body\": \"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](https://developers.bluesnap.com/v8976-Basics/docs/3d-secure#section-step-5-determine-3-d-secure-result) for examples.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Merchant-initiated transactions are out of scope for 3-D Secure.  To make sure your transaction is identified as merchant-initiated, you must use the Merchant Managed Subscription API.  Refer to [Create Merchant-Managed Subscription](https://developers.bluesnap.com/v8976-JSON/docs/create-merchant-managed-subscription) and [Create Merchant-Managed Subscription Charge](https://developers.bluesnap.com/v8976-JSON/docs/create-merchant-managed-subscription-charge) for details.\",\n  \"title\": \"Important\"\n}\n[/block]\n# Before you begin\n* Make sure you've implemented the latest version of [Hosted Payment Fields](/v8976-Tools/docs/hosted-payment-fields) or [Client-Side Encryption](/docs/client-side-encryption).\n\n* Contact [Merchant Support](https://bluesnap.zendesk.com/hc/en-us/requests/new?ticket_form_id=360000127087) and ask for 3-D Secure to be enabled for your account. \n\n* After it has been enabled, activate 3-D Secure in your BlueSnap Console by going to **Settings&nbsp;>&nbsp;Fraud Settings** and selecting **Enable 3D Secure**.\n\n* 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. Make sure to [enable IPNs for your account](https://support.bluesnap.com/docs/ipn-setup).\n\n* 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)\n\n<hr />\n\n# 3-D Secure in Hosted Payment Fields\nIf you're using Hosted Payment Fields, implementing 3DS consists of these steps:\n\n* [Step 1: Prevent your shopper from submitting the form during 3-D Secure setup](#section-step-1-prevent-your-shopper-from-submitting-the-form-during-3-d-secure-setup)\n* [Step 2: Enable 3-D Secure usage in the transaction](#section-step-2-enable-3-d-secure-usage-in-the-transaction)\n* [Step 3: Account for 3-D Secure errors](#section-step-3-account-for-3-d-secure-errors)\n* [Step 4: Create 3-D Secure object with transaction data](#section-step-4-create-3-d-secure-object-with-transaction-data)\n* [Step 5: Determine 3-D Secure result](#section-step-5-determine-3-d-secure-result)\n* [Step 6: Process the transaction with Hosted Payment Fields token](#section-step-6-process-the-transaction-with-hosted-payment-fields-token)\n\n## Step 1: Prevent your shopper from submitting the form during 3-D Secure setup\nIf 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\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button data-bluesnap=\\\"submitButton\\\" type=\\\"submit\\\" id=\\\"submit-button\\\">Pay Now</button>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Important!\",\n  \"body\": \"You must define the `data-bluesnap` value exactly as shown above; otherwise, BlueSnap cannot properly deactivate the button.\"\n}\n[/block]\n## Step 2: Enable 3-D Secure usage in the transaction\nEnable 3DS usage in the transaction by adding the property `'3DS'` to `bsObj` and set its value to `true`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var bsObj = {\\n  ... \\n  '3DS': true\\n}; \",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n## Step 3: Account for 3-D Secure errors\nBlueSnap passes 3DS error codes and descriptions (shown [here](#section-error-codes)) to your `onError` callback function as the `errorCode` and `errorDescription` parameters. Update your `onError` callback function to account for these errors. \n\n## Step 4: Create 3-D Secure object with transaction data\nCreate a 3DS object with at least the transaction amount and currency, as shown in the code below. \nIf you want to submit the credentials and activate 3DS, pass your object as an additional parameter to `bluesnap.submitCredentials` (shown in Step 5).  You can also decide not to activate 3DS and not pass the object.\n\nWhen 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. \n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"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](#section--supported-3-d-secure-object-properties-)).\",\n  \"title\": \"Provide as much transaction data as possible\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var threeDSecureObj = {\\n  amount: 35.75, \\n  currency: 'USD'\\n  ...\\n}; \",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n### **Supported 3-D Secure object properties**\n`amount` &nbsp;&nbsp;&nbsp; *number* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n`currency` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n`billingFirstName` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`billingLastName` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`billingCountry` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`billingState` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`billingCity` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`billingAddress` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`billingZip` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`shippingFirstName` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`shippingLastName` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`shippingCountry` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`shippingState` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`shippingCity` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`shippingAddress` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`shippingZip` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`email` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n`phone` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;optional\n\n## Step 5: Determine 3-D Secure result\nBlueSnap passes the 3DS result to your purchase function callback as `callBack.threeDSecure.authResult`, which has one of the values (shown [here](#section-authentication-results)). Configure your purchase function callback to determine the 3DS result and take appropriate action (refer to the code below for a simple `bluesnap.submitCredentials` call with the changes from Steps 4 and 5). \n\nThe code calls `bluesnap.submitCredentials` with a simple purchase callback function. Here you can decide if you want to activate 3DS by either including the `threeDSecureObj` in `bluesnap.submitCredentials` or you can decide not to activate 3DS and not pass the object.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"bluesnap.submitCredentials(function(callback) {\\n        if (null != callback.cardData) {\\n                console.log(Card type is ' + callback.cardData.ccType +\\n               ', Last 4 digits are ' + callback.cardData.last4Digits +\\n               ', Exp is ' + callback.cardData.exp + \\n               ', Issuing Country is ' + callback.cardData.issuingCountry + \\n               ', 3D Secure result is ' + (callback.threeDSecure != null ? callback.threeDSecure.authResult : null));\\n               // submit form to server & process transaction\\n        } else {\\n               .\\n               .\\n               .\\n        }\\n}, threeDSecureObj);\",\n      \"language\": \"javascript\",\n      \"name\": \"with threeDSecureObj\"\n    },\n    {\n      \"code\": \"bluesnap.submitCredentials(function(callback) {\\n        if (null != callback.cardData) {\\n                console.log('Card type is ' + callback.cardData.ccType +\\n               ', Last 4 digits are ' + callback.cardData.last4Digits +\\n               ', Exp is ' + callback.cardData.exp + \\n               ', Issuing Country is ' + callback.cardData.issuingCountry + \\n               ', 3D Secure result is ' + (callback.threeDSecure != null ? callback.threeDSecure.authResult : null));\\n               // submit form to server & process transaction\\n        } else {\\n               .\\n               .\\n               .\\n        }\\n});\",\n      \"language\": \"javascript\",\n      \"name\": \"without threeDSecureObj\"\n    }\n  ]\n}\n[/block]\n## Step 6: Process the transaction with Hosted Payment Fields token\nProcess 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](/v8976-Tools/docs/hosted-payment-fields#section-in-the-payment-api) for Payment API code samples with `pfToken`.\n\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n<hr />\n\n# 3-D Secure in Client-Side Encryption \nIf you're using Client-Side Encryption, implementing 3-D Secure consists of these steps:\n\n* [Step 1: Add data-bluesnap attributes](#section-step-1-add-data-bluesnap-attributes)\n* [Step 2: Obtain 3-D Secure token for the session](#section-step-2-obtain-3-d-secure-token-for-the-session)\n* [Step 3: Call bluesnap.init3DS to set up 3-D Secure](#section-step-3-call-bluesnap-init3ds-to-set-up-3-d-secure)\n* [Step 4: Create a 3-D Secure object with transaction data](#section-step-4-create-a-3-d-secure-object-with-transaction-data)\n* [Step 5: Call bluesnap.encrypt with 3-D Secure object and callback function](#section-step-5-call-bluesnap-encrypt-with-3-d-secure-object-and-callback-function)\n* [Step 6: Process the transaction with encrypted data](#section-step-6-process-the-transaction-with-encrypted-data)\n\n## Step 1: Add data-bluesnap attributes\nAdd `data-bluesnap` attributes to the expiration month and year fields on your checkout form and set the values to **expirationMonth** and **expirationYear**, respectively (shown below). This allows BlueSnap to access these fields during checkout, which are required as part of the 3DS authentication flow. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"  <div>\\n    <label for=\\\"Expiration\\\">Exp. (MM/YYYY)</label>\\n      <input data-bluesnap=\\\"expirationMonth\\\" type=\\\"text\\\" name=\\\"exp-month\\\" id=\\\"exp-month\\\" size=\\\"2\\\">\\n      <span> / </span>\\n      <input data-bluesnap=\\\"expirationYear\\\" type=\\\"text\\\" name=\\\"exp-year\\\" id=\\\"exp-year\\\" size=\\\"4\\\">\\n  </div>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\nAdd a `data-bluesnap` attribute to your submit button element and set its value to **submitButton** (shown below). This allows BlueSnap to deactivate your button during the 3DS setup process, which you begin in Step 3 by calling `bluesnap.init3DS`. The shopper is prevented from submitting the payment form during the setup process, eliminating the potential for any errors that could result.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<button data-bluesnap=\\\"submitButton\\\" type=\\\"submit\\\" id=\\\"submit-button\\\">Pay Now</button>\",\n      \"language\": \"html\"\n    }\n  ]\n}\n[/block]\n## Step 2: Obtain 3-D Secure token for the session\nObtain the 3-D Secure token for the session by sending a [Create 3D Secure Token](/v8976-Tools/docs/create-3d-secure-token) request, which is a server-to-server POST request sent to:\n`/services/2/threeDSecure`\n\nThe response provides the token as the value of the `threeDSecureToken` property (shown below). Grab the token and send it to the client for the next step.   \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"threeDSecureToken\\\": \\\"eyJhbGciOiJIU...\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Create 3D Secure Token Response\"\n    }\n  ]\n}\n[/block]\n## Step 3: Call bluesnap.init3DS to set up 3-D Secure\nAfter the checkout page has been loaded, begin the 3DS setup process by calling `bluesnap.init3DS` with the following parameters: \n1. The 3-D Secure token (obtained in the prior step)\n2. A callback function to handle an error if it occurs\n\nWhen `bluesnap.init3DS` is called, BlueSnap disables the submit button (which is possible because you added the `data-bluesnap` attribute in Step 1) and set up 3-D Secure. When the process is complete, BlueSnap re-enables the button and calls the provided function. \n\nThe below code calls `bluesnap.init3DS` with its required parameters. Note:  The `result` is always empty. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"bluesnap.init3DS(threeDSecureToken, function(result, error) {\\n  if (error != null) {\\n    // Handle the error. See below. \\n  } else {\\n    // 3D Secure setup was a success. No further action is required. \\n    return; \\n  }\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n### **Handling setup errors**\nIf an error occurs during the setup process, `error` has the following format. Handle the error by calling `bluesnap.init3DS` with a valid token.       \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"errorCode\\\": \\\"14102\\\",\\n  \\\"errorDescription\\\": \\\"3D Secure object is missing required fields { threeDSecureToken }\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Error example\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"To disable 3-D Secure for a specific transaction, remove the `bluesnap.init3DS` call.\",\n  \"title\": \"Disabling 3-D Secure for a specific transaction\"\n}\n[/block]\n## Step 4: Create a 3-D Secure object with transaction data  \nCreate a 3-D Secure object with at least the transaction amount and currency (shown below). In the next step, you call `bluesnap.encrypt` with your object (in addition to other parameters), which allows BlueSnap to send this information to the card issuer to consider as part of their decision whether shopper authentication is required.\n[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"Provide as much transaction data as possible because it can improve the issuer's ability to authenticate the transaction (and assume fraud chargeback liability) without requiring the shopper to enter their credentials in the popup screen, making the 3-D Secure flow entirely transparent and reducing checkout friction (refer to [Supported 3-D Secure object properties](#section--supported-3-d-secure-object-properties-)).\",\n  \"title\": \"Provide as much transaction data as possible\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var threeDSecureObj = {\\n  amount: 3575, \\n  currency: 'USD'\\n  ...\\n}; \",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Note\",\n  \"body\": \"The amount in the example above actually processes \\\"35.75\\\" (with the decimal).\"\n}\n[/block]\n\n## Step 5: Call bluesnap.encrypt with 3-D Secure object and callback function\nWhen the shopper hits the submit button, call `bluesnap.encrypt` like you would normally, but add two additional parameters: \n1. The 3-D Secure object (created in the prior step) \n2. A callback function to handle the authentication result (or error)\n\nWhen the shopper submits their payment and `bluesnap.encrypt` is called, BlueSnap sends the 3D Secure object to the issuer and they decide whether shopper authentication is required. After the authentication process is complete, BlueSnap encrypts the payment form and calls the provided function with the authentication result (or error).  \n\nThe below code calls `bluesnap.encrypt` with its required parameters. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"bluesnap.encrypt(\\\"formID\\\", threeDSecureObj, function(result, error) {\\n  if (error != null) {\\n    // Handle the error. See below. \\n  } else {\\n    // Handle the authentication result. See below.\\n  }\\n}); \",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n### **Handling authentication errors**\nIf an error occurs during the authentication process, `error` has the format of the following example and it contains a set of values (shown [here](#section-error-codes)), which explains how to handle the error accordingly.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"errorCode\\\": \\\"14101\\\",\\n  \\\"errorDescription\\\": \\\"3D Secure authentication was failed because the shopper did not enter correct credentials\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Error example\"\n    }\n  ]\n}\n[/block]\n### **Handling authentication results**\nIf no errors occur during the authentication process, `result` has the format of the following example and `authResult` contains one of the values (shown [here](#section-authentication-results)), which explains how to process the transaction accordingly.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"threeDSecure\\\":{\\n    \\\"authResult\\\":\\\"AUTHENTICATION_SUCCEEDED\\\",\\n    \\\"threeDSecureResultToken\\\":\\\"eyJhbGciOiJIU...\\\"\\n  },\\n  \\\"encryptedCardNumber\\\":\\\"$bsjs_1_0_3$odPj3U+Ap98...\\\",\\n  \\\"encryptedSecurityCode\\\":\\\"$bsjs_1_0_3$a4jfpzZVitf...\\\",\\n  \\\"ccLast4Digits\\\":\\\"0002\\\",\\n  \\\"expirationYear\\\":\\\"2020\\\",\\n  \\\"expirationMonth\\\":\\\"01\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Result example\"\n    }\n  ]\n}\n[/block]\n## Step 6: Process the transaction with encrypted data\nTo process 3-D Secure payments from your server, include the `threeDSecure` object in the request and set its `threeDSecureResultToken` property to the 3-D Secure result token (obtained in the last step). \n\nSample Auth Capture request: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"amount\\\": 11,\\n  \\\"softDescriptor\\\": \\\"DescTest\\\",\\n  \\\"cardHolderInfo\\\": {\\n    \\\"firstName\\\": \\\"test first name\\\",\\n    \\\"lastName\\\": \\\"test last name\\\", \\n    \\\"zip\\\": \\\"123456\\\"\\n  },\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"creditCard\\\": {\\n    \\\"expirationYear\\\": 2023,\\n    \\\"encryptedCardNumber\\\": \\\"$bsjs_1_0_3$odPj3U+Ap98...\\\",\\n    \\\"encryptedSecurityCode\\\": \\\"$bsjs_1_0_3$a4jfpzZVitf...\\\",\\n    \\\"expirationMonth\\\": \\\"07\\\"\\n  },\\n  \\\"cardTransactionType\\\": \\\"AUTH_CAPTURE\\\",\\n  \\\"threeDSecure\\\": {\\n    \\\"threeDSecureResultToken\\\": \\\"eyJhbGciOiJIUzI1NiJ9.eyJqdG...\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"JSON\"\n    }\n  ]\n}\n[/block]\n<br />\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n<hr />\n\n# Processing payments with data from external Merchant Plug-In (MPI)\nIf 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](https://bluesnap.zendesk.com/hc/en-us/requests/new?ticket_form_id=360000127087) and inform them you're using an external MPI so that your account can be configured appropriately. \n\nTo process the payment, include the `threeDSecure` object with the following properties in the request:\n  * `eci`: ECI value. Pass **00**, **01**, or **02** for Mastercard, or **05**, **06**, or **07** for all other card types. \n  * `cavv`: Base64 encoded CAVV obtained from the external MPI. \n  * `xid`: Base64 encoded XID obtained from the external MPI. \n\nSample Auth Capture request: \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"amount\\\": 11,\\n  \\\"softDescriptor\\\": \\\"DescTest\\\",\\n  \\\"cardHolderInfo\\\": {\\n    \\\"firstName\\\": \\\"test first name\\\",\\n    \\\"lastName\\\": \\\"test last name\\\", \\n    \\\"zip\\\": \\\"123456\\\"\\n  },\\n  \\\"currency\\\": \\\"USD\\\",\\n  \\\"creditCard\\\": {\\n    \\\"expirationYear\\\": 2019,\\n    \\\"securityCode\\\": 111,\\n    \\\"expirationMonth\\\": \\\"07\\\",\\n    \\\"cardNumber\\\": 4012000033330026\\n  },\\n  \\\"cardTransactionType\\\": \\\"AUTH_CAPTURE\\\",\\n  \\\"threeDSecure\\\": {\\n    \\\"eci\\\": \\\"05\\\",\\n    \\\"cavv\\\": \\\"AAABAWFlmQAAAABjRWWZEEFgFz+A\\\",\\n    \\\"xid\\\": \\\"MGpHWm5ZWVpKclo0aUk0VmltVDA=\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n<br />\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n<hr />\n\n#Error codes\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Error Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`14100`\",\n    \"0-1\": \"**Problem**:  3-D Secure is not enabled\\n\\n**Resolution**: Enable 3-D Secure\",\n    \"1-0\": \"`14101`\",\n    \"2-0\": \"`14102`\",\n    \"3-0\": \"`14103`\",\n    \"1-1\": \"**Problem**: 3-D Secure authentication failed because the shopper did not enter correct credentials\\n\\n**Resolution**: Inform the shopper to try a different payment method\",\n    \"2-1\": \"**Problem**: 3-D Secure object is missing required fields { ... }\\n\\n**Resolution**: Make sure 3-D Secure object has both transaction amount and currency\",\n    \"3-1\": \"**Problem**: 3-D Secure client error\\n\\n**Resolution**: Continue without 3DS\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n<br />\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n<hr />\n\n# Authentication results\n###`AUTHENTICATION_BYPASSED`###\n* **Meaning**: 3-D Secure authentication was bypassed due to the merchant's configuration. \n* **To Proceed**: Process the transaction without 3-D Secure\n  * [in Hosted Payment Fields](#section-step-6-process-the-transaction-with-hosted-payment-fields-token)\n  * [in Client-Side Encryption](#section--processing-regular-card-payments-with-encrypted-data-)\n\n###`AUTHENTICATION_SUCCEEDED`###\n* **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](https://support.bluesnap.com/docs/3d-secure#section-chargeback-liability-shift). \n* **To Proceed**: \n   * In Hosted Payment Fields:  [Process the 3-D Secure transaction](#section-step-6-process-the-transaction-with-hosted-payment-fields-token)\n   * In Client-Side Encryption:  Send `result.threeDSecure.threeDSecureResultToken` to your server and [process the 3-D Secure transaction](#section--processing-3-d-secure-payments-with-encrypted-data-)\n\n###`AUTHENTICATION_UNAVAILABLE`###\n* **Meaning**: 3-D Secure is unavailable for this card or a technical error occurred.\n* **To Proceed**: Process the transaction without 3-D Secure\n  * [in Hosted Payment Fields](#section-step-6-process-the-transaction-with-hosted-payment-fields-token)\n  * [in Client-Side Encryption](#section--processing-regular-card-payments-with-encrypted-data-)\n\n<br />\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n<hr />","excerpt":"","slug":"3d-secure","type":"basic","title":"3-D Secure for API"}

3-D Secure for API


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

  • For general information about 3-D Secure and 3-D Secure 2.0, refer to the 3-D Secure Guide.
  • For answers to specific questions related to BlueSnap and 3-D Secure 2.0, PSD2, and SCA, refer to our 3-D Secure 2.0 FAQs page.

This guide provides the following information:


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

Merchant-initiated transactions are out of scope for 3-D Secure. 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.

Before you begin

  • Make sure you've implemented the latest version of Hosted Payment Fields or Client-Side Encryption.

  • Contact Merchant Support and ask for 3-D Secure to be enabled for your account.

  • After it has been enabled, activate 3-D Secure in your BlueSnap Console by going to Settings > Fraud Settings and selecting Enable 3D Secure.

  • 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. Make sure to enable IPNs for your account.

  • For information about Sandbox testing of 3-D Secure, refer here


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

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.submitCredentials (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'
  ...
}; 

Supported 3-D Secure object properties

amount     number    required
currency     string    required
billingFirstName     string    optional
billingLastName     string    optional
billingCountry     string    optional
billingState     string    optional
billingCity     string    optional
billingAddress     string    optional
billingZip     string    optional
shippingFirstName     string    optional
shippingLastName     string    optional
shippingCountry     string    optional
shippingState     string    optional
shippingCity     string    optional
shippingAddress     string    optional
shippingZip     string    optional
email     string    optional
phone     string    optional

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.submitCredentials call with the changes from Steps 4 and 5).

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

bluesnap.submitCredentials(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.submitCredentials(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.

Back to Top


3-D Secure in Client-Side Encryption

If you're using Client-Side Encryption, implementing 3-D Secure consists of these steps:

Step 1: Add data-bluesnap attributes

Add data-bluesnap attributes to the expiration month and year fields on your checkout form and set the values to expirationMonth and expirationYear, respectively (shown below). This allows BlueSnap to access these fields during checkout, which are required as part of the 3DS authentication flow.

  <div>
    <label for="Expiration">Exp. (MM/YYYY)</label>
      <input data-bluesnap="expirationMonth" type="text" name="exp-month" id="exp-month" size="2">
      <span> / </span>
      <input data-bluesnap="expirationYear" type="text" name="exp-year" id="exp-year" size="4">
  </div>

Add a data-bluesnap attribute to your submit button element and set its value to submitButton (shown below). This allows BlueSnap to deactivate your button during the 3DS setup process, which you begin in Step 3 by calling bluesnap.init3DS. The shopper is prevented from submitting the payment form during the setup process, eliminating the potential for any errors that could result.

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

Step 2: Obtain 3-D Secure token for the session

Obtain the 3-D Secure token for the session by sending a Create 3D Secure Token request, which is a server-to-server POST request sent to:
/services/2/threeDSecure

The response provides the token as the value of the threeDSecureToken property (shown below). Grab the token and send it to the client for the next step.

{
  "threeDSecureToken": "eyJhbGciOiJIU..."
}

Step 3: Call bluesnap.init3DS to set up 3-D Secure

After the checkout page has been loaded, begin the 3DS setup process by calling bluesnap.init3DS with the following parameters:

  1. The 3-D Secure token (obtained in the prior step)
  2. A callback function to handle an error if it occurs

When bluesnap.init3DS is called, BlueSnap disables the submit button (which is possible because you added the data-bluesnap attribute in Step 1) and set up 3-D Secure. When the process is complete, BlueSnap re-enables the button and calls the provided function.

The below code calls bluesnap.init3DS with its required parameters. Note: The result is always empty.

bluesnap.init3DS(threeDSecureToken, function(result, error) {
  if (error != null) {
    // Handle the error. See below. 
  } else {
    // 3D Secure setup was a success. No further action is required. 
    return; 
  }
});

Handling setup errors

If an error occurs during the setup process, error has the following format. Handle the error by calling bluesnap.init3DS with a valid token.

{
  "errorCode": "14102",
  "errorDescription": "3D Secure object is missing required fields { threeDSecureToken }"
}

Disabling 3-D Secure for a specific transaction

To disable 3-D Secure for a specific transaction, remove the bluesnap.init3DS call.

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

Create a 3-D Secure object with at least the transaction amount and currency (shown below). In the next step, you call bluesnap.encrypt with your object (in addition to other parameters), which allows BlueSnap to send this information to the card issuer to consider as part of their decision whether shopper authentication is required.

Provide as much transaction data as possible

Provide as much transaction data as possible because it can improve the issuer's ability to authenticate the transaction (and assume fraud chargeback liability) without requiring the shopper to enter their credentials in the popup screen, making the 3-D Secure flow entirely transparent and reducing checkout friction (refer to Supported 3-D Secure object properties).

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

Note

The amount in the example above actually processes "35.75" (with the decimal).

Step 5: Call bluesnap.encrypt with 3-D Secure object and callback function

When the shopper hits the submit button, call bluesnap.encrypt like you would normally, but add two additional parameters:

  1. The 3-D Secure object (created in the prior step)
  2. A callback function to handle the authentication result (or error)

When the shopper submits their payment and bluesnap.encrypt is called, BlueSnap sends the 3D Secure object to the issuer and they decide whether shopper authentication is required. After the authentication process is complete, BlueSnap encrypts the payment form and calls the provided function with the authentication result (or error).

The below code calls bluesnap.encrypt with its required parameters.

bluesnap.encrypt("formID", threeDSecureObj, function(result, error) {
  if (error != null) {
    // Handle the error. See below. 
  } else {
    // Handle the authentication result. See below.
  }
}); 

Handling authentication errors

If an error occurs during the authentication process, error has the format of the following example and it contains a set of values (shown here), which explains how to handle the error accordingly.

{
  "errorCode": "14101",
  "errorDescription": "3D Secure authentication was failed because the shopper did not enter correct credentials"
}

Handling authentication results

If no errors occur during the authentication process, result has the format of the following example and authResult contains one of the values (shown here), which explains how to process the transaction accordingly.

{
  "threeDSecure":{
    "authResult":"AUTHENTICATION_SUCCEEDED",
    "threeDSecureResultToken":"eyJhbGciOiJIU..."
  },
  "encryptedCardNumber":"$bsjs_1_0_3$odPj3U+Ap98...",
  "encryptedSecurityCode":"$bsjs_1_0_3$a4jfpzZVitf...",
  "ccLast4Digits":"0002",
  "expirationYear":"2020",
  "expirationMonth":"01"
}

Step 6: Process the transaction with encrypted data

To process 3-D Secure payments from your server, include the threeDSecure object in the request and set its threeDSecureResultToken property to the 3-D Secure result token (obtained in the last step).

Sample Auth Capture request:

{
  "amount": 11,
  "softDescriptor": "DescTest",
  "cardHolderInfo": {
    "firstName": "test first name",
    "lastName": "test last name", 
    "zip": "123456"
  },
  "currency": "USD",
  "creditCard": {
    "expirationYear": 2023,
    "encryptedCardNumber": "$bsjs_1_0_3$odPj3U+Ap98...",
    "encryptedSecurityCode": "$bsjs_1_0_3$a4jfpzZVitf...",
    "expirationMonth": "07"
  },
  "cardTransactionType": "AUTH_CAPTURE",
  "threeDSecure": {
    "threeDSecureResultToken": "eyJhbGciOiJIUzI1NiJ9.eyJqdG..."
  }
}



Back to Top


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.

To process the payment, include the threeDSecure object with the following properties in the request:

  • eci: ECI value. Pass 00, 01, or 02 for Mastercard, or 05, 06, or 07 for all other card types.
  • cavv: Base64 encoded CAVV obtained from the external MPI.
  • xid: Base64 encoded XID obtained from the external MPI.

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="
  }
}



Back to Top


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 because the shopper did not enter correct credentials

Resolution: Inform the shopper to try a different payment method

14102

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



Back to Top


Authentication results

AUTHENTICATION_BYPASSED

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:

AUTHENTICATION_UNAVAILABLE



Back to Top