{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vaulted-shoppers/:vaultedShopperId","auth":"optional","examples":{"codes":[]},"method":"get","results":{"codes":[{"code":"","language":"text"}]},"settings":"57ee593a21ceb20e0061959e","params":[{"name":"vaultedShopperId","type":"string","default":"","desc":"vaultedShopperId received from BlueSnap","required":true,"in":"path","ref":"","_id":"56953ff3fe18811700c9bfcc"}]},"next":{"description":"","pages":[]},"title":"Retrieve Vaulted Shopper","type":"endpoint","slug":"retrieve-vaulted-shopper","excerpt":"","body":"[block:html]\n{\n \"html\": \"<script>\\n // hide body textbox of API Explorer\\n $(document).ready(function() {\\n $(\\\"textarea[placeholder='Body Content']\\\").hide(); \\n }); \\n</script>\"\n}\n[/block]\nThe Retrieve Vaulted Shopper request retrieves all the saved details for the shopper associated with the `vaultedShopperId` 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 `vaultedShopperId` into the web service URL, in the format:\n`services/2/vaulted-shoppers/{vaultedShopperId}`\n\nFor example:\n`services/2/vaulted-shoppers/20769005`\n\n**Retrieve based on Merchant Shopper ID**\nEnter the `merchantShopperId` in the web service URL, in the format:\n`services/2/vaulted-shoppers/merchant/{merchantShopperId}`\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 `vaultedShopper` resource (see [vaultedShopper](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/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\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/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\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\": \"{\\n \\\"paymentSources\\\": {\\n \\\"creditCardInfo\\\": [\\n {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"FirstName\\\",\\n \\\"lastName\\\": \\\"LastName\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"avsResponseCodeAddress\\\": \\\"U\\\",\\n \\\"cvvResponseCode\\\": \\\"ND\\\",\\n \\\"avsResponseCodeName\\\": \\\"U\\\",\\n \\\"avsResponseCodeZip\\\": \\\"U\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2023,\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardFingerprint\\\": \\\"a0f6043de947e8458a5f8b689e8349218d805d02caa622dcddc6b01d93e15ea36f1d2e1c0686623d04b9414eee39671f50fecde671fd2c80f0a6241098144a33\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"expirationMonth\\\": 10\\n },\\n \\\"dateCreated\\\": \\\"09/30/2020\\\",\\n \\\"timeCreated\\\": \\\"05:59:40\\\"\\n }\\n ]\\n },\\n \\\"firstName\\\": \\\"FirstName\\\",\\n \\\"lastName\\\": \\\"LastName\\\",\\n \\\"vaultedShopperId\\\": 19549046,\\n \\\"lastPaymentInfo\\\": {\\n \\\"paymentMethod\\\": \\\"CC\\\",\\n \\\"creditCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardCategory\\\": \\\"CLASSIC\\\"\\n }\\n },\\n \\\"dateCreated\\\": \\\"09/22/2020\\\",\\n \\\"timeCreated\\\": \\\"13:41:10\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"Retrieve Vaulted Shopper with Vaulted Shopper ID Response: 200 OK\"\n },\n {\n \"code\": \"{\\n \\\"paymentSources\\\": {\\n \\\"creditCardInfo\\\": [\\n {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"Jane\\\",\\n \\\"lastName\\\": \\\"Shopper\\\"\\n },\\n \\\"processingInfo\\\": {\\n \\\"avsResponseCodeAddress\\\": \\\"U\\\",\\n \\\"cvvResponseCode\\\": \\\"ND\\\",\\n \\\"avsResponseCodeName\\\": \\\"U\\\",\\n \\\"avsResponseCodeZip\\\": \\\"U\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2023,\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardFingerprint\\\": \\\"a0f6043de947e8458a5f8b689e8349218d805d02caa622dcddc6b01d93e15ea36f1d2e1c0686623d04b9414eee39671f50fecde671fd2c80f0a6241098144a33\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"expirationMonth\\\": 10\\n },\\n \\\"dateCreated\\\": \\\"09/30/2020\\\",\\n \\\"timeCreated\\\": \\\"05:59:40\\\"\\n }\\n ]\\n },\\n \\\"firstName\\\": \\\"Jane\\\",\\n \\\"lastName\\\": \\\"Shopper\\\",\\n \\\"vaultedShopperId\\\": 19549046,\\n \\\"merchantShopperId\\\": \\\"6783334400\\\",\\n \\\"lastPaymentInfo\\\": {\\n \\\"paymentMethod\\\": \\\"CC\\\",\\n \\\"creditCard\\\": {\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardCategory\\\": \\\"CLASSIC\\\"\\n }\\n },\\n \\\"dateCreated\\\": \\\"09/22/2020\\\",\\n \\\"timeCreated\\\": \\\"13:41:10\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"with Merchant Shopper ID Response: 200 OK \"\n },\n {\n \"code\": \"{\\n \\\"vaultedShopperId\\\": 19569754,\\n \\\"firstName\\\": \\\"FirstName\\\",\\n \\\"lastName\\\": \\\"LastName\\\",\\n \\\"country\\\": \\\"us\\\",\\n \\\"zip\\\": \\\"12345\\\",\\n \\\"phone\\\": \\\"1234567890\\\",\\n \\\"shopperCurrency\\\": \\\"USD\\\",\\n \\\"paymentSources\\\": {\\n \\\"ecpDetails\\\": [\\n {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"FirstName\\\",\\n \\\"lastName\\\": \\\"LastName\\\"\\n },\\n \\\"ecp\\\": {\\n \\\"accountType\\\": \\\"CONSUMER_CHECKING\\\",\\n \\\"publicAccountNumber\\\": \\\"99992\\\",\\n \\\"publicRoutingNumber\\\": \\\"75150\\\"\\n },\\n \\\"dateCreated\\\": \\\"09/30/2020\\\",\\n \\\"timeCreated\\\": \\\"05:48:18\\\"\\n },\\n {\\n \\\"billingContactInfo\\\": {\\n \\\"firstName\\\": \\\"FirstName\\\",\\n \\\"lastName\\\": \\\"LastName\\\"\\n },\\n \\\"ecp\\\": {\\n \\\"accountType\\\": \\\"CONSUMER_SAVINGS\\\",\\n \\\"publicAccountNumber\\\": \\\"99993\\\",\\n \\\"publicRoutingNumber\\\": \\\"75151\\\"\\n },\\n \\\"dateCreated\\\": \\\"09/30/2020\\\",\\n \\\"timeCreated\\\": \\\"05:59:40\\\"\\n }\\n ]\\n },\\n \\\"dateCreated\\\": \\\"09/22/2020\\\",\\n \\\"timeCreated\\\": \\\"13:41:10\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"with Multiple ACH: 200 OK\"\n }\n ]\n}\n[/block]\n<hr>\n\n##Example Description\nAbove is an example request. Note that no 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 `vaultedShopperId` field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ff39c12e2e8fa00503ad59e","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Vaulted Shoppers","slug":"vaulted-shopper-service","order":9,"from_sync":false,"reference":true,"_id":"5ff39c12e2e8fa00503ad533","version":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-19T18:31:30.299Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.36.1 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5ff39c12e2e8fa00503ad52d","5ff39c12e2e8fa00503ad52e","5ff39c12e2e8fa00503ad52f","5ff39c12e2e8fa00503ad530","5ff39c12e2e8fa00503ad531","5ff39c12e2e8fa00503ad532","5ff39c12e2e8fa00503ad533","5ff39c12e2e8fa00503ad534","5ff39c12e2e8fa00503ad535","5ff39c12e2e8fa00503ad536","5ff39c12e2e8fa00503ad537","5ff39c12e2e8fa00503ad538","5ff39c12e2e8fa00503ad539","5ff39c12e2e8fa00503ad53a","5ff39c12e2e8fa00503ad53b","5ff39c12e2e8fa00503ad53c","5ff39c12e2e8fa00503ad53d","5ff39c12e2e8fa00503ad53e","5ff39c12e2e8fa00503ad53f"],"_id":"5ff39c12e2e8fa00503ad5e4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5fc6c6094cb8fa066b0d2ea3","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"createdAt":"2016-01-27T20:28:32.932Z","githubsync":"","__v":5}getRetrieve Vaulted Shopper
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Path Params
vaultedShopperId:
required
string
vaultedShopperId received from BlueSnap
Documentation
The Retrieve Vaulted Shopper request retrieves all the saved details for the shopper associated with the vaultedShopperId you send in the request.
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 vaultedShopperId into the web service URL, in the format:services/2/vaulted-shoppers/{vaultedShopperId}
For example:services/2/vaulted-shoppers/20769005
Retrieve based on Merchant Shopper ID
Enter the merchantShopperId in the web service URL, in the format:services/2/vaulted-shoppers/merchant/{merchantShopperId}
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 vaultedShopper resource (see vaultedShopper).
Examples
Request Example
curl -v -X GET https://sandbox.bluesnap.com/services/2/vaulted-shoppers/19549046 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d 'curl -v -X GET https://sandbox.bluesnap.com/services/2/vaulted-shoppers/merchant/6783334400 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '{
"paymentSources": {
"creditCardInfo": [
{
"billingContactInfo": {
"firstName": "FirstName",
"lastName": "LastName"
},
"processingInfo": {
"avsResponseCodeAddress": "U",
"cvvResponseCode": "ND",
"avsResponseCodeName": "U",
"avsResponseCodeZip": "U"
},
"creditCard": {
"expirationYear": 2023,
"cardLastFourDigits": "0026",
"cardFingerprint": "a0f6043de947e8458a5f8b689e8349218d805d02caa622dcddc6b01d93e15ea36f1d2e1c0686623d04b9414eee39671f50fecde671fd2c80f0a6241098144a33",
"cardSubType": "CREDIT",
"cardType": "VISA",
"expirationMonth": 10
},
"dateCreated": "09/30/2020",
"timeCreated": "05:59:40"
}
]
},
"firstName": "FirstName",
"lastName": "LastName",
"vaultedShopperId": 19549046,
"lastPaymentInfo": {
"paymentMethod": "CC",
"creditCard": {
"cardLastFourDigits": "0026",
"cardType": "VISA",
"cardCategory": "CLASSIC"
}
},
"dateCreated": "09/22/2020",
"timeCreated": "13:41:10"
}{
"paymentSources": {
"creditCardInfo": [
{
"billingContactInfo": {
"firstName": "Jane",
"lastName": "Shopper"
},
"processingInfo": {
"avsResponseCodeAddress": "U",
"cvvResponseCode": "ND",
"avsResponseCodeName": "U",
"avsResponseCodeZip": "U"
},
"creditCard": {
"expirationYear": 2023,
"cardLastFourDigits": "0026",
"cardFingerprint": "a0f6043de947e8458a5f8b689e8349218d805d02caa622dcddc6b01d93e15ea36f1d2e1c0686623d04b9414eee39671f50fecde671fd2c80f0a6241098144a33",
"cardSubType": "CREDIT",
"cardType": "VISA",
"expirationMonth": 10
},
"dateCreated": "09/30/2020",
"timeCreated": "05:59:40"
}
]
},
"firstName": "Jane",
"lastName": "Shopper",
"vaultedShopperId": 19549046,
"merchantShopperId": "6783334400",
"lastPaymentInfo": {
"paymentMethod": "CC",
"creditCard": {
"cardLastFourDigits": "0026",
"cardType": "VISA",
"cardCategory": "CLASSIC"
}
},
"dateCreated": "09/22/2020",
"timeCreated": "13:41:10"
}{
"vaultedShopperId": 19569754,
"firstName": "FirstName",
"lastName": "LastName",
"country": "us",
"zip": "12345",
"phone": "1234567890",
"shopperCurrency": "USD",
"paymentSources": {
"ecpDetails": [
{
"billingContactInfo": {
"firstName": "FirstName",
"lastName": "LastName"
},
"ecp": {
"accountType": "CONSUMER_CHECKING",
"publicAccountNumber": "99992",
"publicRoutingNumber": "75150"
},
"dateCreated": "09/30/2020",
"timeCreated": "05:48:18"
},
{
"billingContactInfo": {
"firstName": "FirstName",
"lastName": "LastName"
},
"ecp": {
"accountType": "CONSUMER_SAVINGS",
"publicAccountNumber": "99993",
"publicRoutingNumber": "75151"
},
"dateCreated": "09/30/2020",
"timeCreated": "05:59:40"
}
]
},
"dateCreated": "09/22/2020",
"timeCreated": "13:41:10"
}Example Description
Above is an example request. Note that no 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 vaultedShopperId field. This will automatically insert the ID into the request URL. Leave the Body Content field empty.
