{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Hosted Payment Fields","type":"basic","slug":"hosted-payment-fields","excerpt":"Learn how to implement Hosted Payment Fields for PCI compliance of SAQ-A & maximum flexibility. \nIf you still have questions after reading, check out the [FAQs](https://support.bluesnap.com/v5.0/docs/faqs-hosted-payment-fields).","body":"If you would like to build your custom checkout flow using the API, but keep your PCI compliance requirements limited to the minimal SAQ-A level, BlueSnap’s Hosted Payment Fields are the ideal solution.\n\nHosted Payment Fields are iframes that replace sensitive credit card input fields in your checkout page. When the shopper submits the checkout form, BlueSnap binds this payment data to a token. You can then easily process payments or save shopper details by including the token in your BlueSnap API requests.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This setup guide supports the latest version **4** (Web SDK) of Hosted Payment Fields. If you're currently using version 3.0, visit our Hosted Payment Fields FAQs page to learn how to [upgrade](https://support.bluesnap.com/docs/faqs-hosted-payment-fields#how-can-i-upgrade-from-v30-to-v40-of-the-hosted-payment-fields).\"\n}\n[/block]\nFor setup and usage instructions, see:\n\n:fa-arrow-circle-right: &nbsp;  [Implementing Hosted Payment Fields in your checkout form](#section-implementing-hosted-payment-fields-in-your-checkout-form)\n\n:fa-arrow-circle-right: &nbsp;  [JavaScript errors](#section-bluesnap-javascript-errors)\n\n:fa-arrow-circle-right: &nbsp;  [Updating the BlueSnap token](#section-updating-the-bluesnap-token)\n\n:fa-arrow-circle-right: &nbsp;  [Styling the Hosted Payment Fields](#section-styling-the-hosted-payment-fields)\n\n:fa-arrow-circle-right: &nbsp;  [Example Forms](#section-example-forms)\n\n:fa-arrow-circle-right: &nbsp;  [Using the Hosted Payment Fields token to process payments and save shopper info](#section-using-the-hosted-payment-fields-token-to-process-payments-and-save-shopper-info)\n\n\n###Benefits\n * Control the look and feel of your checkout flow, including the Hosted Payment Fields\n * Simplest level of PCI compliance: SAQ-A\n * Securely capture payment information without your shoppers ever leaving your site\n * Use the Hosted Payment Fields token to complete a sale, as well as create or update a Vaulted Shopper\n * Fraud Prevention [Device Data Check services](https://developers.bluesnap.com/docs/fraud-prevention#section-device-data-checks) are already built-in\n\n###How it works\n1. You create a Hosted Payment Fields token for the specific checkout session, using a server-to-server API call.\n2. On the checkout form, you call BlueSnap’s Hosted Fields JavaScript file with this Hosted Payment Fields token.\n3. After the shopper completes the form and clicks “Submit”, the sensitive payment data from the Hosted Payment Fields is saved in BlueSnap’s database and bound to the Hosted Payment Fields token you provided. This includes the following fields:\n\n  * Credit Card Number\n  * Expiration Month/Year\n  * CVV\n4. Once the form has been submitted, you can use the Hosted Payment Fields token to process the purchase, create a shopper, or update a shopper with the new card details provided on the checkout page. \n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/UqjDlXPRFanwnNFctZID_Hosted_fields_flow.png\",\n        \"Hosted_fields_flow.png\",\n        \"750\",\n        \"275\",\n        \"#ec8c3c\",\n        \"\"\n      ],\n      \"sizing\": \"80\"\n    }\n  ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n<br />\n\n#Implementing Hosted Payment Fields in your checkout form\nFollow the steps below in order to implement Hosted Payment Fields in your checkout form.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Insert the domain for either Sandbox or Production\",\n  \"body\": \"In all steps below, replace the BLUESNAPDOMAINPATH with the relevant domain for either the BlueSnap Sandbox or Production environment, as follows:\\n* Sandbox: `https://sandbox.bluesnap.com`\\n* Production: `https://ws.bluesnap.com`\\n\\nFor 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.\"\n}\n[/block]\n##1. Obtain the Hosted Payment Field token for the session\nObtain the Hosted Payment Field token by sending a server-to-server POST request to:\n\n`BLUESNAPDOMAINPATH/services/2/payment-fields-tokens`\n\nThe response provides the token in the location header. For example: \n`BLUESNAPDOMAINPATH/services/2/payment-fields-tokens/HOSTEDFIELDTOKENID`\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You will need a BlueSnap account in order to generate a Hosted Payment Field token. If you don't have an account yet, you can [sign up for one here](http://home.bluesnap.com/get-started/).\",\n  \"title\": \"Note:\"\n}\n[/block]\nThe Hosted Payment Fields Token expires after 60 minutes.\n\n##2. Add the BlueSnap JavaScript file to your checkout form\nIn your checkout page, call the BlueSnap Hosted Payment Fields JavaScript file by adding the following script:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script type=\\\"text/javascript\\\" src=\\\"BLUESNAPDOMAINPATH/web-sdk/4/bluesnap.js\\\"></script>\",\n      \"language\": \"javascript\",\n      \"name\": \"Adding Hosted Payment Fields JavaScript file\"\n    }\n  ]\n}\n[/block]\n##3. Add the Hosted Payment Fields to your checkout form\nReplace the credit card number, expiration date, and CVV input fields in your checkout form with the following `<div>` elements. \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Important!\",\n  \"body\": \"The values for the `data-bluesnap` attributes must be typed exactly as they appear in the below code in order for your implementation to work.\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<div data-bluesnap=\\\"ccn\\\"></div>\\n\\t\\t\\t\\n<div data-bluesnap=\\\"exp\\\"></div>\\n\\t\\t\\t\\n<div data-bluesnap=\\\"cvv\\\"></div>\",\n      \"language\": \"html\",\n      \"name\": \"Hosted Payment Fields <div> elements\"\n    }\n  ]\n}\n[/block]\n##4. Add a script to initiate the Hosted Payment Fields with your Hosted Fields token\nIn order to call the Hosted Payment Fields script, add the following script to your checkout page below the `<div>` elements.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script>\\n    var bsObj = {\\n        token: \\\" HOSTEDFIELDTOKENID \\\",\\n        onFieldEventHandler: {\\n            /*OPTIONAL*/ setupComplete: function () {\\n                console.warn(\\\"setupComplete\\\");\\n            },\\n            /*OPTIONAL*/threeDsChallengeExecuted: function () {\\n                console.warn(\\\"threeDsChallengeExecuted\\\");\\n            },\\n            // tagId returns: \\\"ccn\\\", \\\"cvv\\\", \\\"exp\\\" \\n            onFocus: function (tagId) { }, // Handle focus\\n            onBlur: function (tagId) { }, // Handle blur \\n            onError: function (tagId, errorCode /*, errorDescription*/) { }, // Handle a change in validation\\n            /*errorCode returns:\\n                \\\"10\\\" --> invalidCcNumber, invalidExpDate, invalidCvv Dependent on the tagId;\\n                \\\"22013\\\" --> \\\"CC type is not supported by the merchant\\\"; \\n                \\\"14040\\\" --> \\\" Token is expired\\\";\\n                \\\"14041\\\" --> \\\" Could not find token\\\";\\n                \\\"14042\\\" --> \\\" Token is not associated with a payment method, please verify your client integration or contact BlueSnap support\\\";\\n                \\\"400\\\" --> \\\"Session expired please refresh page to continue\\\";\\n                \\\"403\\\", \\\"404\\\", \\\"500\\\" --> \\\"Internal server error please try again later\\\"; \\n            */\\n\\n            /* errorDescription is optional. Returns BlueSnap's standard error description */\\n\\n            onType: function (tagId, cardType  /*, cardData*/) {\\n                /* cardType will give card type, and only applies to ccn: AMEX, VISA, MASTERCARD, AMEX, DISCOVER, DINERS, JCB */\\n                if (null != cardData) {\\n                    /* cardData is an optional parameter which will provide ccType, last4Digits, issuingCountry, isRegulatedCard, cardSubType, binCategory and ccBin details (only applies to ccn) in a JsonObject */\\n                    console.log(cardData);\\n                }\\n            },\\n\\n            onValid: function (tagId) { }, // Handle a change in validation\\n        },\\n        /* example:\\n            style: {\\n            \\\"Selector\\\": {\\n            \\\"Property\\\": \\\"Value\\\",\\n            \\\"Property2\\\": \\\"Value2\\\"\\n            },                                                                                                                                                             \\n            \\\"Selector2\\\": {\\n            \\\"Property\\\": \\\"Value\\\"\\n            } \\n        }, */\\n        style: {\\n            \\\":focus\\\": {\\n                //style for all input elements on focus event\\n                \\\"color\\\": \\\"orange\\\"\\n            },\\n            \\\"input\\\": {\\n                //style for all input elements \\n                \\\"color\\\": \\\"blue\\\"\\n            },\\n            \\\".invalid\\\": {\\n                //style for all input elements when invalid\\n                \\\"color\\\": \\\"red\\\"\\n            }\\n        },\\n        ccnPlaceHolder: \\\"1234 5678 9012 3456\\\", //for example\\n        cvvPlaceHolder: \\\"123\\\", //for example\\n        expPlaceHolder: \\\"MM/YY\\\" //for example\\n    };\\n\\n    //Run the following command after Document Object Model (DOM) is fully loaded \\n    bluesnap.hostedPaymentFieldsCreate(bsObj);\\n</script>\",\n      \"language\": \"html\",\n      \"name\": \"Initiating Hosted Payment Fields with token\"\n    }\n  ]\n}\n[/block]\nReplace `HOSTEDFIELDTOKENID` with the token you obtained in step 1.\n\nUse `onFieldEventHandler` to handle focus, blur, validation events, and to get the card type. For example, you can use this to identify when the user has entered a Visa card and then show the relevant icon for Visa.\n\n**Note:** If you want to use BlueSnap icons per card type, they are available at `BLUESNAPDOMAINPATH/source/web-sdk/hosted-payment-fields/cc-types` as follows:\n\n  * **AMEX**: `amex.png`\n  * **DINERS**: `diners.png`\n  * **DISCOVER**: `discover.png`\n  * **JCB**: `jcb.png`\n  * **MASTERCARD**: `mastercard.png`\n  * **VISA**: `visa.png`\n\nStyling is optional. For more details on the `style` capabilities, see [Styling the Hosted Payment Fields](#section-styling-the-hosted-payment-fields).\n\nOptionally, use these to define what placeholder appears in each Hosted Payment Field input:\n  * `ccnPlaceHolder`\n  * `cvvPlaceHolder`\n  * `expPlaceHolder`\n\n##5. Add a script to submit credit card, expiration date, and CVV data\nAdd the script below into your checkout form:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<script>\\n    function do_when_clicking_submit_button(){\\n        bluesnap.hostedPaymentFieldsSubmitData( function(callback){\\n            if (null != callback.cardData) {\\n                console.log('card type: ' + callback.cardData.ccType +\\n                ', last 4 digits: ' + callback.cardData.last4Digits +\\n                ', exp: ' + callback.cardData.exp + \\n                ', issuing Country: ' + callback.cardData.issuingCountry + \\n                ', isRegulatedCard: ' + callback.cardData.isRegulatedCard + \\n                ', cardSubType: ' + callback.cardData.cardSubType + \\n                ', binCategory: ' + callback.cardData.binCategory + \\n                ' and ccBin: ' + callback.cardData.ccBin + \\n               ', after that I can call final submit');\\n                // submit the form\\n            } else {\\n                var errorArray = callback.error;\\n                for (i in errorArray) {\\n                    console.log(\\\"Received error: tagId= \\\" +\\n                    errorArray[i].tagId + \\\", errorCode= \\\" +\\n                    errorArray[i].errorCode + \\\", errorDescription= \\\" +\\n                    errorArray[i].errorDescription);\\n                }\\n            }\\n        });\\n    }                                                            \\n</script>\",\n      \"language\": \"html\",\n      \"name\": \"Submit payment data to BlueSnap\"\n    }\n  ]\n}\n[/block]\nThis function should be activated when the shopper clicks the **Submit **button. This submits the credit card number, expiration date, and CVV data to BlueSnap, where it is associated with the Hosted Payment Fields token.\n\nIf the data submission to BlueSnap is successful, a card data object containing the card type, last four digits, and expiration date are passed to the `function(callback) { // callback.cardData}`, else if there is an error in submission `callback.error` receives an array and each item contains `errorArray[i].tagId, errorArray[i].errorCode, errorArray[i].errorDescription`, if it is either a client error or server error.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The card is validated when you send it in a transaction or you save it to a shopper.\",\n  \"title\": \"Card validation\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Add 3D Secure for increased checkout security\",\n  \"body\": \"Visit the [3D Secure guide](/docs/3-d-secure-for-api) to learn how to add 3D Secure to your configuration.\"\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n# BlueSnap JavaScript errors\nThe following are all the errors that can be passed to your `onError` callback function in the `errorCode` and `errorDescription` parameters. \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"errorCode\",\n    \"h-1\": \"errorDescription value\",\n    \"0-0\": \"`'10'`\",\n    \"0-1\": \"* If `tagId` is `'ccn'`, `errorDescription` is 'invalidCcNumber'.\\n* If `tagId` is `'cvv'`, `errorDescription` is 'invalidCvv'. \\n* If `tagId` is `'exp'`, `errorDescription` is 'invalidExpDate'.\",\n    \"1-0\": \"`'22013'`\",\n    \"1-1\": \"'CC type is not supported by the merchant'\",\n    \"2-0\": \"`'14040'`\",\n    \"2-1\": \"'Token is expired'\",\n    \"3-0\": \"`'14041'`\",\n    \"3-1\": \"'Could not find token'\",\n    \"4-0\": \"`'14042'`\",\n    \"4-1\": \"'Token is not associated with a payment method, \\nplease verify your client integration or contact BlueSnap support'\",\n    \"5-0\": \"`'400'`\",\n    \"5-1\": \"'Session expired please refresh page to continue'\",\n    \"6-0\": \"`'403'`, `'404'`, `'500'`\",\n    \"6-1\": \"'Internal server error please try again later'\",\n    \"7-0\": \"3-D Secure Errors\",\n    \"7-1\": \"For all the 3-D Secure JavaScript errors, see the [3-D Secure for API Guide](/docs/3-d-secure-for-api#section-error-codes).\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n#Updating the BlueSnap Token\nIf the token expires (expiration occurs after 60 minutes, see [error code event 14040](https://developers.bluesnap.com/v8976-Tools/docs/hosted-payment-field-errors)), you can update it by creating a new token (see [Obtain the Hosted Payment Field token for the session](https://developers.bluesnap.com/v8976-Tools/docs/hosted-payment-fields#section-1-obtain-the-hosted-payment-field-token-for-the-session)) and update the solution accordingly:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"bluesnap.hostedPaymentFieldsUpdateToken(new token string);\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n#Styling the Hosted Payment Fields\nMuch of the styling of the Hosted Payment Fields (i.e. width, height, and outer styling) can be performed as usual via CSS.\n\nThe Hosted Payment Fields are iframes within the `<div>` containers, and they are nearly invisible in terms of styling. The iframes themselves do not have a border and their width and height are 100%. Input inside the iframes has no border margin or padding, has a width and height of 100%, and has a transparent background. Placeholders for inputs are provided automatically. \n\nTo apply styling inside of the Hosted Payment Fields, use the `style` JavaScript shown in [step 4](#section-4-add-a-script-to-initiate-the-hosted-payment-fields-with-your-hosted-fields-token).\n\n##Supported CSS properties\nWe support the following CSS properties inside of the Hosted Payment Fields:\n* `-webkit-appearance`\n* `appearance`\n* `background-color`, `background-origin`, `background-position`, `background-repeat`, `background-size`\n* `border-bottom`, `border-bottom-color`, `border-bottom-left-radius`, `border-bottom-right-radius`, `border-bottom-style`, `border-bottom-width`, `border-color`, `border-left`, `border-left-color`, `border-left-style`, `border-left-width`, `border-radius`, `border-right`, `border-right-color`, `border-right-style`, `border-right-width`, `border-style`, `border-top`, `border-top-color`, `border-top-left-radius`, `border-top-right-radius`, `border-top-style`, `border-top-width`, `border-width`\n* `bottom`\n* `color`\n* `display`\n* `font`, `font-family`, `font-size`, `font-style`, `font-weight`\n* `height`\n* `left`\n* `letter-spacing`\n* `line-height`\n* `margin`, `margin-bottom`, `margin-left`, `margin-right`, `margin-right`, `margin-top`\n* `opacity`\n* `outline`\n* `padding`, `padding-bottom`, `padding-left`, `padding-right`, `padding-top`\n* `position`,\n* `right`\n* `text-align`\n* `text-decoration`\n* `text-shadow`\n* `top`\n* `transition`\n* `width`\n\n**Note:** Using any *unsupported* CSS properties results in failure of the Hosted Payment Fields.\n\n##Selectors\nYou can use the following selectors to define when the style is applied:\n* `#ccn`, `#ccn:focus`, `#ccn:focus:-moz-placeholder`, `#ccn:focus:-ms-input-placeholder`, `#ccn:focus::-moz-placeholder`, `#ccn:focus::placeholder`, `#ccn:focus::-webkit-input-placeholder`, `#ccn:hover`, `#ccn.invalid`, `#ccn.valid`\n* `#cvv`, `#cvv:focus`, `#cvv:focus:-moz-placeholder`, `#cvv:focus:-ms-input-placeholder`, `#cvv:focus::-moz-placeholder`, `#cvv:focus::placeholder`, `#cvv:focus::-webkit-input-placeholder`, `#cvv:hover`, `#cvv.invalid`, `#cvv.valid`\n* `#exp:hover`\n* `:focus`, `:focus:-moz-placeholder`, `:focus:-ms-input-placeholder`, `:focus::-moz-placeholder`, `:focus::placeholder`, `:focus::-webkit-input-placeholder`\n* `:hover`, `:hover::placeholder`\n* `input`\n* `.invalid`, `.invalid:focus`\n* `:-moz-placeholder`\n* `::-moz-placeholder`\n* `:-ms-input-placeholder`\n* `::placeholder`\n* `.valid`, `.valid:focus`\n* `::-webkit-input-placeholder`\n\n\n##Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var bsObj = {\\n  //...\\n  style: {\\n    \\\"input\\\": {\\n      //style for all input elements\\n      \\\"font\\\": \\\"bold 14px Arial\\\",\\n      \\\"color\\\": \\\"#4A5157\\n    },\\n    \\\":focus\\\": {\\n      //style for all elements on focus event\\n      \\\"color\\\": \\\"orange\\\"\\n    },\\n    \\\"#ccn\\\": {\\n      //style only ccn element\\n      \\\"color\\\": \\\"blue\\\"\\n    },\\n    \\\"#cvv.invalid\\\": {\\n      //style cvv input when invalid\\n      \\\"color\\\": \\\"red\\\"\\n    }\\n  }\\n};\",\n      \"language\": \"javascript\",\n      \"name\": \"Example styling inside of the Hosted Payment Fields\"\n    }\n  ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n#Example forms\nBelow are two examples of checkout forms that use BlueSnap's Hosted Payment Fields.  Click the HTML/CSS/JS tabs to view the code.\n\n##Example 1: with Bootstrap styling\n[block:html]\n{\n  \"html\": \"<iframe height='537' scrolling='no' src='//codepen.io/BlueSnap/embed/xxKYdyJ/?height=537&theme-id=0&default-tab=js,result&embed-version=2' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'>\\n</iframe>\"\n}\n[/block]\n##Example 2: with Material styling   \n[block:html]\n{\n  \"html\": \"<iframe height='537' scrolling='no' src='//codepen.io/BlueSnap/embed/YzKVyZR/?height=537&theme-id=0&default-tab=js,result&embed-version=2' frameborder='no' allowtransparency='true' allowfullscreen='true' style='width: 100%;'>\\n</iframe>\"\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n#Using the Hosted Payment Fields token to process payments and save shopper info\nOnce you have implemented Hosted Payment Fields in your checkout form, you can then process payments, as well as save shopper information, by including the Hosted Payment Fields token in your API requests. See below for more information on how to do this in either the Payment API or the Extended Payment API.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The Hosted Payment Fields token can be used only once to either process a transaction or save shopper payment info.\",\n  \"title\": \"Note:\"\n}\n[/block]\n##In the Payment API\nTo use the Hosted Payment Fields token to process a payment, send the token within the `pfToken` property in your [Auth Capture](/v8976-JSON/docs/auth-capture), [Auth Only](/v8976-JSON/docs/auth-only), or [Create Subscription](/v8976-JSON/docs/create-subscription).\n\nTo save the card information from the Hosted Payment Fields in a new or existing vaulted shopper, send the token within the `pfToken` property in your [Create Vaulted Shopper](/v8976-JSON/docs/create-vaulted-shopper) or [Update Vaulted Shopper](/v8976-JSON/docs/update-vaulted-shopper) request.\n\nExample requests:\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    \\\"cardTransactionType\\\": \\\"AUTH_CAPTURE\\\",\\n    \\\"pfToken\\\": \\\"abcde12345**********\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Card transaction with hosted payment field token\"\n    },\n    {\n      \"code\": \"{\\n    \\\"paymentSources\\\": {\\\"creditCardInfo\\\": [{\\\"pfToken\\\": \\\"9688f4f6945f615b1ab6954ceb5dbf67f63d6b41fa27dbff6ac342cff9bf50fc_\\\"}]},\\n    \\\"firstName\\\": \\\"FirstName\\\",\\n    \\\"lastName\\\": \\\"LastName\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Create vaulted shopper with hosted payment field token\"\n    },\n    {\n      \"code\": \"{\\n    \\\"firstName\\\": \\\"FirstName\\\",\\n    \\\"lastName\\\": \\\"LastName\\\",\\n    \\\"paymentSources\\\": {\\\"creditCardInfo\\\": [{\\n         \\\"pfToken\\\": \\\"9688f4f6945f615b1ab6954ceb5dbf67f63d6b41fa27dbff6ac342cff9bf50fc_\\\"\\n    }]}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Update vaulted shopper with hosted payment field token\"\n    }\n  ]\n}\n[/block]\n##In the Extended Payment API\n\n###New shopper\nTo use the Hosted Payment Fields token to process a payment for a **new shopper**, you can  send the token within the `pf-token` property in your [Create Order and New Shopper](/v8976-Extended/docs/create-shopper-and-order) or [Create Shopping Context](/v8976-Extended/docs/create-shopping-context) request.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<batch-order xmlns=\\\"http://ws.plimus.com\\\">\\n  <shopper>\\n    <web-info>\\n      <ip>62.219.121.253</ip>\\n    </web-info>\\n    <shopper-info>\\n      <shopper-currency>USD</shopper-currency>\\n      <store-id>4677</store-id>\\n      <locale>en</locale>\\n      <shopper-contact-info>\\n        <title>Mr.</title>\\n        <first-name>John</first-name>\\n        <last-name>Doe</last-name>\\n        <email>jdoe:::at:::johndoeandsons.com</email>\\n        <company-name>JohnDoeAndSons</company-name>\\n        <address1>138 Market st</address1>\\n        <city>San Francisco</city>\\n        <zip>756543</zip>\\n        <state>CA</state>\\n        <country>US</country>\\n        <phone>1413555666</phone>\\n        <fax>1413555666789</fax>\\n      </shopper-contact-info>\\n      <payment-info>\\n        <credit-cards-info>\\n          <credit-card-info>\\n            <billing-contact-info>\\n              <first-name>John</first-name>\\n              <last-name>Doe</last-name>\\n              <address1>138 Market st</address1>\\n              <city>San Francisco</city>\\n              <zip>756543</zip>\\n              <state>CA</state>\\n              <country>US</country>\\n            </billing-contact-info>\\n            <pf-token>c7c69ff853ab784ef35a0c78ffec08e78cf1d1b5b4bb9e2644c2bcc73f3f818f_1</pf-token>\\n          </credit-card-info>\\n        </credit-cards-info>\\n      </payment-info>\\n    </shopper-info>\\n  </shopper>\\n  <order>\\n    <ordering-shopper>\\n      <web-info>\\n        <ip>62.219.121.253</ip>\\n        <remote-host>www.merchant.com</remote-host>\\n        <user-agent>Mozilla/5.0 (Linux; X11)</user-agent>\\n      </web-info>\\n    </ordering-shopper>\\n    <cart>\\n      <cart-item>\\n        <sku>\\n          <sku-id>2152762</sku-id>\\n        </sku>\\n        <quantity>1</quantity>\\n      </cart-item>\\n    </cart>\\n    <expected-total-price>\\n      <amount>15.00</amount>\\n      <currency>USD</currency>\\n    </expected-total-price>\\n  </order>\\n</batch-order>\",\n      \"language\": \"xml\",\n      \"name\": \"Create Order and New Shopper Request: Hosted Payment Fields for new shopper\"\n    },\n    {\n      \"code\": \"<shopping-context xmlns=\\\"http://ws.plimus.com\\\">\\n  <web-info>\\n    <ip>62.219.121.253</ip>\\n    <remote-host>\\n    bzq-219-121-253.static.bezeqint.net.reinventhosting.com</remote-host>\\n    <user-agent>Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;\\n    SV1; GTB6.3; .NET CLR 2.0.50727)</user-agent>\\n    <accept-language>en-us</accept-language>\\n  </web-info>\\n  <shopper-details>\\n    <shopper>\\n      <shopper-info>\\n        <shopper-contact-info>\\n          <title>Mr</title>\\n          <first-name>shopper first name</first-name>\\n          <last-name>shopper last name</last-name>\\n          <email>[email protected]</email>\\n          <company-name>JS Company</company-name>\\n          <address1>123 Oxford</address1>\\n          <address2 />\\n          <city>London</city>\\n          <state>ny</state>\\n          <zip>54321</zip>\\n          <country>us</country>\\n          <phone>1800808080</phone>\\n          <fax>1800808080</fax>\\n        </shopper-contact-info>\\n        <shipping-contact-info>\\n          <first-name>Shipping first name</first-name>\\n          <last-name>Shipping last name</last-name>\\n          <address1>123 Oxford</address1>\\n          <address2 />\\n          <city>London</city>\\n          <state>ny</state>\\n          <zip>54321</zip>\\n          <country>us</country>\\n        </shipping-contact-info>\\n        <invoice-contacts-info>\\n          <invoice-contact-info>\\n            <default>true</default>\\n            <company-name>BlueSnap UK</company-name>\\n            <vat-code></vat-code>\\n            <title>Mrs.</title>\\n            <first-name>John</first-name>\\n            <last-name>Black</last-name>\\n            <address1>5 star drive</address1>\\n            <address2>3rd entrance</address2>\\n            <city>Purchase</city>\\n            <state>NY</state>\\n            <zip>34645</zip>\\n            <country>us</country>\\n            <phone>1800400500</phone>\\n            <fax>1800400500</fax>\\n            <email>[email protected]</email>\\n          </invoice-contact-info>\\n        </invoice-contacts-info>\\n        <payment-info>\\n          <credit-cards-info>\\n            <credit-card-info>\\n              <billing-contact-info>\\n                <first-name>John</first-name>\\n                <last-name>Doe</last-name>\\n                <address1>138 Market st</address1>\\n                <city>San Francisco</city>\\n                <zip>756543</zip>\\n                <state>CA</state>\\n                <country>US</country>\\n              </billing-contact-info>\\n              <pf-token>c7c69ff853ab784ef35a0c78ffec08e78cf1d1b5b4bb9e2644c2bcc73f3f818f_1</pf-token>\\n            </credit-card-info>\\n          </credit-cards-info>\\n        </payment-info>\\n        <store-id>12700</store-id>\\n        <vat-code></vat-code>\\n        <shopper-currency>USD</shopper-currency>\\n        <locale>en</locale>\\n      </shopper-info>\\n    </shopper>\\n  </shopper-details>\\n  <order-details>\\n    <order>\\n      <cart>\\n        <cart-item>\\n          <sku>\\n            <sku-id>2178316</sku-id>\\n            <sku-charge-price>\\n              <charge-type>initial</charge-type>\\n              <amount>50.00</amount>\\n              <currency>USD</currency>\\n            </sku-charge-price>\\n          </sku>\\n          <quantity>1</quantity>\\n        </cart-item>\\n      </cart>\\n      <expected-total-price>\\n        <amount>50.00</amount>\\n        <currency>USD</currency>\\n      </expected-total-price>\\n    </order>\\n  </order-details>\\n</shopping-context>\",\n      \"language\": \"xml\",\n      \"name\": \"Create Shopping Context Request: Hosted Payment Fields for new shopper\"\n    }\n  ]\n}\n[/block]\n###Existing shopper\nTo use the Hosted Payment Fields token to process a payment for an **existing shopper**, first update the existing shopper with the information from the Hosted Payment Fields by sending the token within the `pf-token` property in your [Update Shopper](/v8976-Extended/docs/update-shopper) request.\n\nYou can then process the payment as usual, by including the relevant shopper ID in the [Create Order with Existing Shopper](/v8976-Extended/docs/create-order) or [Create Shopping Context](/v8976-Extended/docs/create-shopping-context) request.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<shopper xmlns=\\\"http://ws.plimus.com\\\">\\n  <web-info>\\n    <ip>62.219.121.253</ip>\\n  </web-info>\\n  <shopper-info>\\n    <store-id>4677</store-id>\\n    <payment-info>\\n      <credit-cards-info>\\n        <credit-card-info>\\n          <billing-contact-info>\\n            <first-name>John</first-name>\\n            <last-name>Doe</last-name>\\n            <address1>138 Market st</address1>\\n            <city>San Francisco</city>\\n            <zip>756543</zip>\\n            <state>CA</state>\\n            <country>US</country>\\n          </billing-contact-info>\\n          <pf-token>c7c69ff853ab784ef35a0c78ffec08e78cf1d1b5b4bb9e2644c2bcc73f3f818f_1</pf-token>\\n        </credit-card-info>\\n      </credit-cards-info>\\n    </payment-info>\\n  </shopper-info>\\n</shopper>\",\n      \"language\": \"xml\",\n      \"name\": \"Update Shopper Request: adding Hosted Payment Fields token\"\n    }\n  ]\n}\n[/block]\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fa1893ed2a2370028d2426d","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.36 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5fa1893ed2a2370028d2421e","5fa1893ed2a2370028d2421f","5fa1893ed2a2370028d24220","5fa1893ed2a2370028d24221","5fa1893ed2a2370028d24222","5fa1893ed2a2370028d24223","5fa1893ed2a2370028d24224","5fa1893ed2a2370028d24225","5fa1893ed2a2370028d24226","5fa1893ed2a2370028d24227","5fa1893ed2a2370028d24228","5fa1893ed2a2370028d24229","5b34c737e0dca2000311de6a","5fa1893ed2a2370028d2422a","5fa1893ed2a2370028d2422b","5fa1893ed2a2370028d2422c","5fa1893ed2a2370028d2422d","5fa1893ed2a2370028d2422e","5fa1893ed2a2370028d2422f","5fa18956dd369d003cb51fc6"],"_id":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5f4d276c4ff932005f3e3b86","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Hosted Payment Fields","slug":"hosted-payment-fields","order":9,"from_sync":false,"reference":true,"_id":"5fa1893ed2a2370028d24220","version":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-05-19T19:19:37.628Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2019-08-06T17:04:10.904Z","__v":0,"parentDoc":null}