{"_id":"59a45d457ee621000fc9d3ef","category":{"_id":"59a45d447ee621000fc9d3bf","version":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-10-19T18:31:30.299Z","from_sync":false,"order":7,"slug":"vaulted-shopper-service","title":"Vaulted Shoppers"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"59a45d437ee621000fc9d3b7","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-08-28T18:13:23.840Z","releaseDate":"2017-08-28T18:13:23.840Z","categories":["59a45d447ee621000fc9d3b8","59a45d447ee621000fc9d3b9","59a45d447ee621000fc9d3ba","59a45d447ee621000fc9d3bb","59a45d447ee621000fc9d3bc","59a45d447ee621000fc9d3bd","59a45d447ee621000fc9d3be","59a45d447ee621000fc9d3bf","59a45d447ee621000fc9d3c0","59a45d447ee621000fc9d3c1","59a45d447ee621000fc9d3c2","59a45d447ee621000fc9d3c3","59a45d447ee621000fc9d3c4","59a45d447ee621000fc9d3c5","59a45d447ee621000fc9d3c6","59a45d447ee621000fc9d3c7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.1","version_clean":"8976.0.0-XML","version":"8976-XML"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-27T20:28:32.932Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"text","code":""}]},"settings":"","auth":"optional","params":[{"_id":"56953ff3fe18811700c9bfcc","ref":"","in":"path","required":true,"desc":"vaulted-shopper-id received from BlueSnap","default":"","type":"string","name":"vaulted-shopper-id"}],"url":"/vaulted-shoppers/:vaulted-shopper-id"},"isReference":true,"order":18,"body":"The Retrieve Vaulted Shopper request retrieves all the saved details for the shopper associated with the `vaulted-shopper-id` you send in the request.\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\nNo content is required in the request body. Enter the relevant IDs in the request URL, as follows:\n\n**Retrieve based on Vaulted Shopper ID**\nEnter the `vaulted-shopper-id` into the web service URL, in the format:\n`services/2/vaulted-shoppers/{vaulted-shopper-id}`\n\nFor example:\n`services/2/vaulted-shoppers/20769005`\n\n**Retrieve based on Merchant Shopper ID**\nEnter the `merchant-shopper-id` in the web service URL, in the format:\n`services/2/vaulted-shoppers/merchant/{merchant-shopper-id}`\n\nFor example:\n`services/2/vaulted-shoppers/merchant/6783334400`\n\n###Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `vaulted-shopper` resource (see [vaulted-shopper](doc:vaulted-shopper)).\n\n<hr>\n\n##Examples\n\n###Request Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549046 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Vaulted Shopper with Vaulted Shopper ID\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/vaulted-shoppers/merchant/6783334400 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve Vaulted Shopper with Merchant Shopper ID\"\n    }\n  ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 200 OK\\n\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<vaulted-shopper xmlns=\\\"http://ws.plimus.com\\\">\\n   <vaulted-shopper-id>19549046</vaulted-shopper-id>\\n   <first-name>FirstName</first-name>\\n   <last-name>LastName</last-name>\\n   <payment-sources>\\n      <credit-card-info>\\n         <billing-contact-info>\\n            <first-name>FirstName</first-name>\\n            <last-name>LastName</last-name>\\n         </billing-contact-info>\\n         <credit-card>\\n            <card-last-four-digits>0026</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>10</expiration-month>\\n            <expiration-year>2020</expiration-year>\\n            <card-fingerprint>a0f6043de947e8458a5f8b689e8349218d805d02caa622dcddc6b01d93e15ea36f1d2e1c0686623d04b9414eee39671f50fecde671fd2c80f0a6241098144a33</card-fingerprint>\\n         </credit-card>\\n         <processing-info>\\n            <cvv-response-code>ND</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</vaulted-shopper>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Vaulted Shopper with Vaulted Shopper ID Response: 200 OK\"\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>21516109</vaulted-shopper-id>\\n    <merchant-shopper-id>6783334400</merchant-shopper-id>\\n    <first-name>Jane</first-name>\\n    <last-name>Shopper</last-name>\\n    <shopper-currency>USD</shopper-currency>\\n    <payment-sources>\\n        <credit-card-info>\\n            <billing-contact-info>\\n                <first-name>Jane</first-name>\\n                <last-name>Shopper</last-name>\\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>2018</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</vaulted-shopper>\",\n      \"language\": \"xml\",\n      \"name\": \"Retrieve Vaulted Shopper with Merchant Shopper ID Response: 200 OK\"\n    }\n  ]\n}\n[/block]\n<hr>\n\n##Example Description\nAbove is an example request. Note that no XML content is required in the request body. The retrieval is based on the vaulted shopper ID in the request URL.\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a> \n\n<hr>\n##API Explorer\nTo test out a call, enter an existing vaulted shopper ID (e.g *20769005*) in the `vaulted-shopper-id` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","excerpt":"","slug":"retrieve-vaulted-shopper","type":"get","title":"Retrieve Vaulted Shopper"}

getRetrieve Vaulted Shopper


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

vaulted-shopper-id:
required
string
vaulted-shopper-id received from BlueSnap

Documentation

The Retrieve Vaulted Shopper request retrieves all the saved details for the shopper associated with the vaulted-shopper-id you send in the request.

Try it in the API Explorer

Request Content

No content is required in the request body. Enter the relevant IDs in the request URL, as follows:

Retrieve based on Vaulted Shopper ID
Enter the vaulted-shopper-id into the web service URL, in the format:
services/2/vaulted-shoppers/{vaulted-shopper-id}

For example:
services/2/vaulted-shoppers/20769005

Retrieve based on Merchant Shopper ID
Enter the merchant-shopper-id in the web service URL, in the format:
services/2/vaulted-shoppers/merchant/{merchant-shopper-id}

For example:
services/2/vaulted-shoppers/merchant/6783334400

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved vaulted-shopper resource (see vaulted-shopper).


Examples

Request Example

curl -v -X GET https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549046 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/vaulted-shoppers/merchant/6783334400 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Example

HTTP/ 1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<vaulted-shopper xmlns="http://ws.plimus.com">
   <vaulted-shopper-id>19549046</vaulted-shopper-id>
   <first-name>FirstName</first-name>
   <last-name>LastName</last-name>
   <payment-sources>
      <credit-card-info>
         <billing-contact-info>
            <first-name>FirstName</first-name>
            <last-name>LastName</last-name>
         </billing-contact-info>
         <credit-card>
            <card-last-four-digits>0026</card-last-four-digits>
            <card-type>VISA</card-type>
            <card-sub-type>CREDIT</card-sub-type>
            <card-category>CLASSIC</card-category>
            <expiration-month>10</expiration-month>
            <expiration-year>2020</expiration-year>
            <card-fingerprint>a0f6043de947e8458a5f8b689e8349218d805d02caa622dcddc6b01d93e15ea36f1d2e1c0686623d04b9414eee39671f50fecde671fd2c80f0a6241098144a33</card-fingerprint>
         </credit-card>
         <processing-info>
            <cvv-response-code>ND</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>
</vaulted-shopper>
HTTP/ 1.1 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vaulted-shopper xmlns="http://ws.plimus.com">
    <vaulted-shopper-id>21516109</vaulted-shopper-id>
    <merchant-shopper-id>6783334400</merchant-shopper-id>
    <first-name>Jane</first-name>
    <last-name>Shopper</last-name>
    <shopper-currency>USD</shopper-currency>
    <payment-sources>
        <credit-card-info>
            <billing-contact-info>
                <first-name>Jane</first-name>
                <last-name>Shopper</last-name>
            </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>2018</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>
</vaulted-shopper>


Example Description

Above is an example request. Note that no XML content is required in the request body. The retrieval is based on the vaulted shopper ID in the request URL.


Back to Top


API Explorer

To test out a call, enter an existing vaulted shopper ID (e.g 20769005) in the vaulted-shopper-id field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.


User Information

Try It Out


get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}