{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vaulted-shoppers/:vaulted-shopper-id","auth":"optional","settings":"","results":{"codes":[{"code":"","language":"text"}]},"method":"put","examples":{"codes":[]},"params":[{"name":"vaulted-shopper-id","type":"string","default":"","desc":"vaulted-shopper-id received from BlueSnap","required":false,"in":"path","ref":"","_id":"56ab9094f25f160d00e17f11"}]},"next":{"description":"","pages":[]},"title":"Update Vaulted Shopper","type":"endpoint","slug":"update-vaulted-shopper","excerpt":"","body":"The Update Vaulted Shopper request enables you to update an existing vaulted shopper by changing their contact info, adding and deleting payment methods, or adding wallet details.\n\n**Note**: We recommend that you first retrieve the vaulted shopper and then modify the desired property.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"* Each vaulted shopper can have multiple credit cards.\\n\\n* If you send a credit card number that does not yet exist in that vaulted shopper, BlueSnap validates the card as part of adding it to the shopper.\\n\\n* If you send a credit card number that does exist in that vaulted shopper, BlueSnap validates the card and updates the shopper with any changes to that card's expiration date.\\n\\n* You will obtain the `walletId` when the shopper successfully completes the MasterPass payment step. For a complete walkthrough of the flow for Masterpass, see [Implementing Masterpass via the API](/docs/masterpass#section-implementing-masterpass-via-the-api).\"\n}\n[/block]\n<a class=\"btn btn-success\" href=\"#section-api-explorer-api-version-2-0-\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n`vaulted-shopper` *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [vaulted-shopper](doc:vaulted-shopper)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`first-name` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if `wallet-id` is not sent</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`last-name` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required** if `wallet-id` is not sent</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`soft-descriptor` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`descriptor-phone-number` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`country` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`state` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`city` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`address` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`address2` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`email` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`zip` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`phone` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`company-name` &nbsp;&nbsp;&nbsp; *string* \n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`shopper-currency` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`payment-sources` *container* &nbsp;&nbsp;&nbsp;optional, can contain `credit-card-info` (see [payment-sources](doc:payment-sources))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`shipping-contact-info` *container* &nbsp;&nbsp;&nbsp;optional (see [shipping-contact-info](doc:shipping-contact-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`wallet-id` *long* &nbsp;&nbsp;&nbsp;optional &nbsp; Include if adding MasterPass or Visa Checkout wallet details\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`transaction-fraud-info` *container* &nbsp;&nbsp;&nbsp;optional (see [transaction-fraud-info](doc:transaction-fraud-info))\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`three-d-secure` *container* &nbsp;&nbsp;&nbsp;optional (see [three-d-secure](https://developers.bluesnap.com/v8976-XML/docs/three-d-secure))\n\n###Response Details\nThe response content depends on which version of the API you are using (see [Authentication & headers](/docs/authentication)), as follows:\n\n**API version 2.0 or 3.0**\nIf successful, the response HTTP status code is 200 OK.\nThe response body includes the [vaulted-shopper](doc:vaulted-shopper) resource, which contains all details that are saved for that shopper.\n\n**API version 1.0**\nIf successful, the response HTTP status code is 204 No Content.\n\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n   <first-name>FirstName</first-name>\\n   <last-name>LastName</last-name>\\n   <soft-descriptor>MyCompany</soft-descriptor>\\n   <payment-sources>\\n      <credit-card-info>\\n         <credit-card>\\n            <card-number>4263982640269299</card-number>\\n            <security-code>837</security-code>\\n            <expiration-month>02</expiration-month>\\n            <expiration-year>2023</expiration-year>\\n         </credit-card>\\n      </credit-card-info>\\n   </payment-sources>\\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"Update Vaulted Shopper Request: add credit card\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n   <wallet-id>21</wallet-id> \\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"with wallet ID\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n    <payment-sources>\\n        <credit-card-info>\\n          <pf-token>9688f4f6945f615b1ab6954ceb5dbf67f63d6b41fa27dbff6ac342cff9bf50fc_</pf-token>\\n        </credit-card-info>\\n     </payment-sources>\\n     <first-name>FirstName</first-name>\\n     <last-name>LastName</last-name>\\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"with Hosted Payment Fields token \"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n   <first-name>Jane</first-name>\\n   <last-name>Shopper</last-name>\\n   <zip>12345</zip>\\n   <phone>1234567890</phone>\\n   <country>fr</country>\\n   <payment-sources>\\n      <sepa-direct-debit-info>\\n         <sepa-direct-debit>\\n         \\t<iban>DE09100100101234567893</iban>\\n         </sepa-direct-debit>\\n      </sepa-direct-debit-info>\\n   </payment-sources>\\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"with SEPA Direct Debit \"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n   <first-name>FirstName</first-name>\\n   <last-name>LastName</last-name>\\n   <soft-descriptor>MyCompany</soft-descriptor>\\n   <payment-sources>\\n      <ecp-details>\\n              <billing-contact-info>\\n              <company-name>Scott LLC</company-name>\\n        </billing-contact-info>\\n         <ecp>\\n              <account-number>4099999992</account-number>\\n              <routing-number>011075150</routing-number>\\n              <account-type>CORPORATE_CHECKING</account-type>\\n         </ecp>\\n      </ecp-details>\\n   </payment-sources>\\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"with mulitple ACH\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n   <first-name>FirstName</first-name>\\n   <last-name>LastName</last-name>\\n   <payment-sources>\\n      <credit-card-info>\\n         <credit-card>\\n            <card-last-four-digits>9299</card-last-four-digits>\\n            <card-type>VISA</card-type>\\n         </credit-card>\\n         <status>D</status>\\n      </credit-card-info>\\n   </payment-sources>\\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"delete credit card\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n    <vaulted-shopper-id>19570232</vaulted-shopper-id>\\n    <first-name>John</first-name>\\n    <last-name>Doe</last-name>\\n    <zip>12345</zip>\\n    <phone>1234567890</phone>\\n    <shopper-currency>USD</shopper-currency>\\n    <payment-sources>\\n        <ecp-details>\\n            <billing-contact-info>\\n                <first-name>John</first-name>\\n                <last-name>Doe</last-name>\\n                <zip>12345</zip>\\n            </billing-contact-info>\\n            <ecp>\\n                <account-type>CONSUMER_CHECKING</account-type>\\n                <public-account-number>99992</public-account-number>\\n                <public-routing-number>75150</public-routing-number>\\n            </ecp>\\n            <status>D</status>\\n        </ecp-details>\\n    </payment-sources>\\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"delete ACH/ECP\"\n    },\n    {\n      \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n\\t<first-name>FirstName</first-name>\\n\\t<last-name>LastName</last-name>\\n\\t<country>fr</country>\\n\\t<zip>12345</zip>\\n\\t<phone>1234567890</phone>\\n\\t<payment-sources>\\n\\t\\t<sepa-direct-debit-info>\\n\\t\\t\\t<billing-contact-info>\\n\\t\\t\\t\\t<first-name>FirstName</first-name>\\n\\t\\t\\t\\t<last-name>LastName</last-name>\\n\\t\\t\\t</billing-contact-info>\\n\\t\\t\\t<sepa-direct-debit>\\n\\t\\t\\t\\t<iban-first-four>DE09</iban-first-four>\\n\\t\\t\\t\\t<iban-last-four>7891</iban-last-four>\\n\\t\\t\\t</sepa-direct-debit>\\n\\t\\t\\t<status>D</status>\\n\\t\\t</sepa-direct-debit-info>\\n\\t</payment-sources>\\n</vaulted-shopper>'\",\n      \"language\": \"curl\",\n      \"name\": \"delete SEPA\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n    <vaulted-shopper-id>19569754</vaulted-shopper-id>\\n    <first-name>FirstName</first-name>\\n    <last-name>LastName</last-name>\\n    <company-name></company-name>\\n    <shopper-currency>USD</shopper-currency>\\n    <payment-sources>\\n        <ecp-details>\\n            <billing-contact-info>\\n                <first-name>FirstName</first-name>\\n                <last-name>LastName</last-name>\\n            </billing-contact-info>\\n            <ecp>\\n                <account-type>CONSUMER_CHECKING</account-type>\\n                <public-account-number>99992</public-account-number>\\n                <public-routing-number>75150</public-routing-number>\\n            </ecp>\\n        </ecp-details>\\n        <ecp-details>\\n            <billing-contact-info>\\n                <first-name>FirstName</first-name>\\n                <last-name>LastName</last-name>\\n            </billing-contact-info>\\n            <ecp>\\n                <account-type>CONSUMER_SAVINGS</account-type>\\n                <public-account-number>99993</public-account-number>\\n                <public-routing-number>75151</public-routing-number>\\n            </ecp>\\n        </ecp-details>\\n        <ecp-details>\\n            <billing-contact-info>\\n                <first-name>FirstName</first-name>\\n                <last-name>LastName</last-name>\\n                <city></city>\\n                <company-name>Scott LLC</company-name>\\n            </billing-contact-info>\\n            <ecp>\\n                <account-type>CORPORATE_CHECKING</account-type>\\n                <public-account-number>99992</public-account-number>\\n                <public-routing-number>75150</public-routing-number>\\n            </ecp>\\n        </ecp-details>\\n    </payment-sources>\\n    <fraud-result-info>\\n        <device-data-collector>Y</device-data-collector>\\n    </fraud-result-info>\\n</vaulted-shopper>\",\n      \"language\": \"xml\",\n      \"name\": \"Update Vaulted Shopper Response: 200 OK - API v3.0\"\n    },\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\" standalone=\\\"yes\\\"?>\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n    <vaulted-shopper-id>19549048</vaulted-shopper-id>\\n    <first-name>FirstName</first-name>\\n    <last-name>LastName</last-name>\\n    <shopper-currency>USD</shopper-currency>\\n    <payment-sources>\\n        <credit-card-info>\\n            <billing-contact-info>\\n                <first-name>FirstName</first-name>\\n                <last-name>LastName</last-name>\\n                <city></city>\\n            </billing-contact-info>\\n            <credit-card>\\n                <card-last-four-digits>9299</card-last-four-digits>\\n                <card-type>VISA</card-type>\\n                <card-sub-type>CREDIT</card-sub-type>\\n                <card-category>CLASSIC</card-category>\\n                <expiration-month>02</expiration-month>\\n                <expiration-year>2023</expiration-year>\\n            </credit-card>\\n            <processing-info>\\n                <cvv-response-code>MA</cvv-response-code>\\n                <avs-response-code-zip>U</avs-response-code-zip>\\n                <avs-response-code-address>U</avs-response-code-address>\\n                <avs-response-code-name>U</avs-response-code-name>\\n            </processing-info>\\n        </credit-card-info>\\n    </payment-sources>\\n    <last-payment-info>\\n       <payment-method>CC</payment-method>\\n       <credit-card>\\n          <card-last-four-digits>0026</card-last-four-digits>\\n          <card-type>VISA</card-type>\\n       </credit-card>\\n    </last-payment-info>\\n    <fraud-result-info>\\n        <device-data-collector>N</device-data-collector>\\n    </fraud-result-info>\\n</vaulted-shopper>\",\n      \"language\": \"xml\",\n      \"name\": \"200 OK - API v2.0\"\n    },\n    {\n      \"code\": \"HTTP/ 1.1 204 No Content\",\n      \"language\": \"xml\",\n      \"name\": \"204 No Content - API v1.0\"\n    }\n  ]\n}\n[/block]\n##Example Descriptions\n###Add Credit Card\nThis example request shows how to add another credit card to an existing vaulted shopper.\n\n###Add Wallet Details using Wallet ID\nThis example request adds details from a wallet (e.g. MasterPass). This will add the credit card info from the wallet to the vaulted shopper.\n\n###Add Payment Details using Hosted Payment Fields token\nThis example request adds payment details collected by Hosted Payment Fields to the vaulted shopper.\n\n###Add bank account details for SEPA Direct Debit payment method \nThis example request adds bank account details for the [SEPA Direct Debit](/docs/sepa-direct-debit) payment method.\n\n###Delete**&ast;** credit card\nThis example request shows how to delete a credit card from a vaulted shopper. Include the `status` property in the request and set its value to **D**. Specify the card to be deleted by including `card-type` and `card-last-four-digits`. \n\n###Delete**&ast;** ACH/ECP\nThis example request shows how to delete an ACH/ECP payment method from a vaulted shopper. Include the `status` property in the request and set its value to **D**. Specify the `ecp-details` to be deleted by including `account-type`, `public-account-number`, and `public-routing-number`. \n\n###Delete**&ast;** SEPA\nThis example request shows how to delete a SEPA payment method from a vaulted shopper. Include the `status` property in the request and set its value to **D**. Specify the `sepa-direct-debit-info` to be deleted by including `iban-first-four` and `iban-last-four`. \n\n#####**&ast;** Notes on deleting a payment method\n\n* If you attempt to delete a payment method that is linked to a subscription, an error occurs. Send an Update Subscription request to either switch the shopper's payment source or to cancel the subscription, and then retry the Update Vaulted Shopper request to delete the payment method.\n\n* You cannot delete a payment method if there is a payment pending approval for the payment method.\n\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##API Explorer\nTo test out a call, in the `vaulted-shopper-id` field, enter the ID of an existing vaulted shopper. In the Body Content field, paste in the XML portion of the request and then click **Try it!**\n\n**Tip**: Copy the XML portion from one of the example requests above, or use the XML code below as a starting point. You can enter different parameters and test credit card numbers to see how your test scenario would work. *The request headers, including authorization, are already built in for you in this test area, so you should not include them here.*\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n   <first-name>FirstName</first-name>\\n   <last-name>LastName</last-name>\\n   <payment-sources>\\n      <credit-card-info>\\n         <credit-card>\\n            <card-number>4263982640269299</card-number>\\n            <security-code>837</security-code>\\n            <expiration-month>02</expiration-month>\\n            <expiration-year>2023</expiration-year>\\n         </credit-card>\\n      </credit-card-info>\\n   </payment-sources>\\n</vaulted-shopper>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ed5174637c3c607440c0a20","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.34.0 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ed5174637c3c607440c098b","5ed5174637c3c607440c098c","5ed5174637c3c607440c098d","5ed5174637c3c607440c098e","5ed5174637c3c607440c098f","5ed5174637c3c607440c0990","5ed5174637c3c607440c0991","5ed5174637c3c607440c0992","5ed5174637c3c607440c0993","5ed5174637c3c607440c0994","5ed5174637c3c607440c0995","5ed5174637c3c607440c0996","5ed5174637c3c607440c0997","5ed5174637c3c607440c0998","5ed5174637c3c607440c0999","5ed5174637c3c607440c099a","5ed5174637c3c607440c099b","5ed5174637c3c607440c099c"],"_id":"5ed5174637c3c607440c0a3c","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5e5d3a02fb6fb40050cb3c15","createdAt":"2018-04-24T15:24:22.608Z","releaseDate":"2018-04-24T15:24:22.608Z"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Vaulted Shoppers","slug":"vaulted-shopper-service","order":8,"from_sync":false,"reference":true,"_id":"5ed5174637c3c607440c0992","version":"5ed5174637c3c607440c0a3c","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-19T18:31:30.299Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2018-12-19T14:43:47.802Z","__v":17,"parentDoc":null}