{"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[/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* <span style=\"color:#F37500\">**required**</span>, contains the following properties (see [vaulted-shopper](doc:vaulted-shopper)):\n `first-name` *string* <span style=\"color:#F37500\">**required** if `wallet-id` is not sent</span>\n `last-name` *string* <span style=\"color:#F37500\">**required** if `wallet-id` is not sent</span>\n `soft-descriptor` *string* optional\n `descriptor-phone-number` *string* optional\n `country` *string* optional\n `state` *string* optional\n `city` *string* optional\n `address` *string* optional\n `address2` *string* optional\n `email` *string* optional\n `zip` *string* optional\n `phone` *string* optional\n `company-name` *string* \n `shopper-currency` *string* optional\n `payment-sources` *container* optional, can contain `credit-card-info` (see [payment-sources](doc:payment-sources))\n `shipping-contact-info` *container* optional (see [shipping-contact-info](doc:shipping-contact-info))\n `wallet-id` *long* optional Include if adding Visa Checkout wallet details\n `transaction-fraud-info` *container* optional (see [transaction-fraud-info](doc:transaction-fraud-info))\n `three-d-secure` *container* optional (see [three-d-secure](https://developers.bluesnap.com/v8976-XML/docs/three-d-secure))\n `chosen-payment-method` *container* optional (see [chosen-payment-method](doc:chosen-payment-method))\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 \\t<billing-contact-info>\\n \\t<company-name>Scott LLC</company-name>\\n \\t</billing-contact-info>\\n \\t<ecp>\\n \\t\\t <account-number>4099999992</account-number>\\n \\t\\t <routing-number>011075150</routing-number>\\n \\t\\t <account-type>CORPORATE_CHECKING</account-type>\\n \\t\\t</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 <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 \"code\": \"curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/29872832 \\\\\\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 <chosen-payment-method>\\n <credit-card>\\n <card-last-four-digits>9299</card-last-four-digits>\\n <card-type>VISA</card-type>\\n </credit-card>\\n </chosen-payment-method>\\n</vaulted-shopper>'\",\n \"language\": \"curl\",\n \"name\": \"with chosen payment method\"\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 <expiration-month>04</expiration-month>\\n <expiration-year>2023</expiration-year>\\n <security-code>837</security-code>\\n </credit-card>\\n </credit-card-info>\\n </payment-sources>\\n</vaulted-shopper>'\",\n \"language\": \"curl\",\n \"name\": \"Update expiration date\"\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>19549048</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 <date-created>09/30/2020</date-created>\\n <time-created>05:48:18</time-created>\\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 <date-created>09/30/2020</date-created>\\n <time-created>05:59:40</time-created>\\n </ecp-details>\\n </payment-sources>\\n <fraud-result-info>\\n <device-data-collector>Y</device-data-collector>\\n </fraud-result-info>\\n <date-created>09/22/2020</date-created>\\n <time-created>13:41:10</time-created>\\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. Visa Checkout). 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###Update expiration date\nThis example request shows how to update the expiration date on a vaulted shopper credit card. For the update to happen, the full credit card number is not required. Include the `card-last-four-digits`, the `card-type`, and either the `expiration-month`, `expiration-year`, or both. The new card will then be authorized. **Note**: you are not required to specify the `security-code`, but if it is present, it will be used in the authorization process. \n\n###Delete***** 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***** 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***** 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###Add a chosen payment method\nThis example request shows how to specify a vaulted shopper's chosen (default) credit card from their saved credit cards. Include `chosen-payment-method` in the request with the card details. To create a transaction with the shopper's chosen card, simply omit the payment details from the transaction request. BlueSnap will use the shopper's default card to process the transaction. \n\n#####***** 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":"61a5208deadb750070998f1d","project":"57336fd5a6a9c40e00e13a0b","version":{"version":"8976-XML","version_clean":"8976.0.0-XML","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a5208deadb750070998e87","61a5208deadb750070998e88","61a5208deadb750070998e89","61a5208deadb750070998e8a","61a5208deadb750070998e8b","61a5208deadb750070998e8c","61a5208deadb750070998e8d","61a5208deadb750070998e8e","61a5208deadb750070998e8f","61a5208deadb750070998e90","61a5208deadb750070998e91","61a5208deadb750070998e92","61a5208deadb750070998e93","61a5208deadb750070998e94","61a5208deadb750070998e95","61a5208deadb750070998e96","61a5208deadb750070998e97","61a5208deadb750070998e98","61a5208deadb750070998e99","61a5208deadb750070998e9a"],"_id":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed269718a45001c25b4a0","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":10,"from_sync":false,"reference":true,"_id":"61a5208deadb750070998e8e","version":"61a5208deadb750070998f48","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-19T18:31:30.299Z","__v":0},"user":"5beb1b96bc2003003ecd645e","createdAt":"2018-12-19T14:43:47.802Z","__v":29,"parentDoc":null}
putUpdate Vaulted Shopper
Definition
Parameters
Path Params
Documentation
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.
Note: We recommend that you first retrieve the vaulted shopper and then modify the desired property.
Each vaulted shopper can have multiple credit cards.
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.
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.
Request Content
vaulted-shopper
container required, contains the following properties (see vaulted-shopper):
first-name
string required if wallet-id
is not sent
last-name
string required if wallet-id
is not sent
soft-descriptor
string optional
descriptor-phone-number
string optional
country
string optional
state
string optional
city
string optional
address
string optional
address2
string optional
email
string optional
zip
string optional
phone
string optional
company-name
string
shopper-currency
string optional
payment-sources
container optional, can contain credit-card-info
(see payment-sources)
shipping-contact-info
container optional (see shipping-contact-info)
wallet-id
long optional Include if adding Visa Checkout wallet details
transaction-fraud-info
container optional (see transaction-fraud-info)
three-d-secure
container optional (see three-d-secure)
chosen-payment-method
container optional (see chosen-payment-method)
Response Details
The response content depends on which version of the API you are using (see Authentication & headers), as follows:
API version 2.0 or 3.0
If successful, the response HTTP status code is 200 OK.
The response body includes the vaulted-shopper resource, which contains all details that are saved for that shopper.
API version 1.0
If successful, the response HTTP status code is 204 No Content.
Examples
Request Examples
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<soft-descriptor>MyCompany</soft-descriptor>
<payment-sources>
<credit-card-info>
<credit-card>
<card-number>4263982640269299</card-number>
<security-code>837</security-code>
<expiration-month>02</expiration-month>
<expiration-year>2023</expiration-year>
</credit-card>
</credit-card-info>
</payment-sources>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<wallet-id>21</wallet-id>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<payment-sources>
<credit-card-info>
<pf-token>9688f4f6945f615b1ab6954ceb5dbf67f63d6b41fa27dbff6ac342cff9bf50fc_</pf-token>
</credit-card-info>
</payment-sources>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>Jane</first-name>
<last-name>Shopper</last-name>
<zip>12345</zip>
<phone>1234567890</phone>
<country>fr</country>
<payment-sources>
<sepa-direct-debit-info>
<sepa-direct-debit>
<iban>DE09100100101234567893</iban>
</sepa-direct-debit>
</sepa-direct-debit-info>
</payment-sources>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<soft-descriptor>MyCompany</soft-descriptor>
<payment-sources>
<ecp-details>
<billing-contact-info>
<company-name>Scott LLC</company-name>
</billing-contact-info>
<ecp>
<account-number>4099999992</account-number>
<routing-number>011075150</routing-number>
<account-type>CORPORATE_CHECKING</account-type>
</ecp>
</ecp-details>
</payment-sources>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<payment-sources>
<credit-card-info>
<credit-card>
<card-last-four-digits>9299</card-last-four-digits>
<card-type>VISA</card-type>
</credit-card>
<status>D</status>
</credit-card-info>
</payment-sources>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>John</first-name>
<last-name>Doe</last-name>
<zip>12345</zip>
<phone>1234567890</phone>
<shopper-currency>USD</shopper-currency>
<payment-sources>
<ecp-details>
<billing-contact-info>
<first-name>John</first-name>
<last-name>Doe</last-name>
<zip>12345</zip>
</billing-contact-info>
<ecp>
<account-type>CONSUMER_CHECKING</account-type>
<public-account-number>99992</public-account-number>
<public-routing-number>75150</public-routing-number>
</ecp>
<status>D</status>
</ecp-details>
</payment-sources>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<country>fr</country>
<zip>12345</zip>
<phone>1234567890</phone>
<payment-sources>
<sepa-direct-debit-info>
<billing-contact-info>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
</billing-contact-info>
<sepa-direct-debit>
<iban-first-four>DE09</iban-first-four>
<iban-last-four>7891</iban-last-four>
</sepa-direct-debit>
<status>D</status>
</sepa-direct-debit-info>
</payment-sources>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/29872832 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>Jane</first-name>
<last-name>Shopper</last-name>
<chosen-payment-method>
<credit-card>
<card-last-four-digits>9299</card-last-four-digits>
<card-type>VISA</card-type>
</credit-card>
</chosen-payment-method>
</vaulted-shopper>'
curl -v -X PUT https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549048 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<payment-sources>
<credit-card-info>
<credit-card>
<card-last-four-digits>9299</card-last-four-digits>
<card-type>VISA</card-type>
<expiration-month>04</expiration-month>
<expiration-year>2023</expiration-year>
<security-code>837</security-code>
</credit-card>
</credit-card-info>
</payment-sources>
</vaulted-shopper>'
<vaulted-shopper xmlns="http://ws.plimus.com">
<vaulted-shopper-id>19549048</vaulted-shopper-id>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<company-name></company-name>
<shopper-currency>USD</shopper-currency>
<payment-sources>
<ecp-details>
<billing-contact-info>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
</billing-contact-info>
<ecp>
<account-type>CONSUMER_CHECKING</account-type>
<public-account-number>99992</public-account-number>
<public-routing-number>75150</public-routing-number>
</ecp>
<date-created>09/30/2020</date-created>
<time-created>05:48:18</time-created>
</ecp-details>
<ecp-details>
<billing-contact-info>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
</billing-contact-info>
<ecp>
<account-type>CONSUMER_SAVINGS</account-type>
<public-account-number>99993</public-account-number>
<public-routing-number>75151</public-routing-number>
</ecp>
</ecp-details>
<ecp-details>
<billing-contact-info>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<city></city>
<company-name>Scott LLC</company-name>
</billing-contact-info>
<ecp>
<account-type>CORPORATE_CHECKING</account-type>
<public-account-number>99992</public-account-number>
<public-routing-number>75150</public-routing-number>
</ecp>
<date-created>09/30/2020</date-created>
<time-created>05:59:40</time-created>
</ecp-details>
</payment-sources>
<fraud-result-info>
<device-data-collector>Y</device-data-collector>
</fraud-result-info>
<date-created>09/22/2020</date-created>
<time-created>13:41:10</time-created>
</vaulted-shopper>
HTTP/ 1.1 200 OK
<vaulted-shopper xmlns="http://ws.plimus.com">
<vaulted-shopper-id>19549048</vaulted-shopper-id>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<shopper-currency>USD</shopper-currency>
<payment-sources>
<credit-card-info>
<billing-contact-info>
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<city></city>
</billing-contact-info>
<credit-card>
<card-last-four-digits>9299</card-last-four-digits>
<card-type>VISA</card-type>
<card-sub-type>CREDIT</card-sub-type>
<card-category>CLASSIC</card-category>
<expiration-month>02</expiration-month>
<expiration-year>2023</expiration-year>
</credit-card>
<processing-info>
<cvv-response-code>MA</cvv-response-code>
<avs-response-code-zip>U</avs-response-code-zip>
<avs-response-code-address>U</avs-response-code-address>
<avs-response-code-name>U</avs-response-code-name>
</processing-info>
</credit-card-info>
</payment-sources>
<last-payment-info>
<payment-method>CC</payment-method>
<credit-card>
<card-last-four-digits>0026</card-last-four-digits>
<card-type>VISA</card-type>
</credit-card>
</last-payment-info>
<fraud-result-info>
<device-data-collector>N</device-data-collector>
</fraud-result-info>
</vaulted-shopper>
HTTP/ 1.1 204 No Content
Example Descriptions
Add Credit Card
This example request shows how to add another credit card to an existing vaulted shopper.
Add Wallet Details using Wallet ID
This example request adds details from a wallet (e.g. Visa Checkout). This will add the credit card info from the wallet to the vaulted shopper.
Add Payment Details using Hosted Payment Fields token
This example request adds payment details collected by Hosted Payment Fields to the vaulted shopper.
Add bank account details for SEPA Direct Debit payment method
This example request adds bank account details for the SEPA Direct Debit payment method.
Update expiration date
This example request shows how to update the expiration date on a vaulted shopper credit card. For the update to happen, the full credit card number is not required. Include the card-last-four-digits
, the card-type
, and either the expiration-month
, expiration-year
, or both. The new card will then be authorized. Note: you are not required to specify the security-code
, but if it is present, it will be used in the authorization process.
Delete* credit card
This 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
.
Delete* ACH/ECP
This 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
.
Delete* SEPA
This 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
.
Add a chosen payment method
This example request shows how to specify a vaulted shopper's chosen (default) credit card from their saved credit cards. Include chosen-payment-method
in the request with the card details. To create a transaction with the shopper's chosen card, simply omit the payment details from the transaction request. BlueSnap will use the shopper's default card to process the transaction.
* Notes on deleting a payment method
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.
You cannot delete a payment method if there is a payment pending approval for the payment method.
API Explorer
To 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!
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.
<vaulted-shopper xmlns="http://ws.plimus.com">
<first-name>FirstName</first-name>
<last-name>LastName</last-name>
<payment-sources>
<credit-card-info>
<credit-card>
<card-number>4263982640269299</card-number>
<security-code>837</security-code>
<expiration-month>02</expiration-month>
<expiration-year>2023</expiration-year>
</credit-card>
</credit-card-info>
</payment-sources>
</vaulted-shopper>