{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/vaulted-shoppers/:vaultedShopperId","auth":"optional","method":"delete","examples":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","results":{"codes":[{"language":"text","code":""}]},"params":[{"name":"vaultedShopperId","type":"string","default":"","desc":"vaultedShopperId received from BlueSnap","required":false,"in":"path","ref":"","_id":"60ae9d9f25560d0070cc2c33"}]},"next":{"description":"","pages":[]},"title":"Delete Vaulted Shopper","type":"endpoint","slug":"delete-vaulted-shopper","excerpt":"","body":"To delete a shopper in BlueSnap, you will perform the Delete Vaulted Shopper request. In order to do this, you need either the BlueSnap token (`vaultedShopperId`) or the `merchantShopperId` for your shopper.\n\n<a class=\"btn btn-success\" href=\"#section-api-explorer\" role=\"button\">Try it in the API Explorer</a>\n\n###Request Content\n\nNo content is required in the request body. Enter the relevant IDs in the request URL, as follows:\n\n**Delete 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**Delete 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\n\nA successful response looks like this:\n`HTTP 200\n{\n    \"description\": \"Your request to delete shopper ID 19570408 has been received and will be processed within 7 days.\"\n}`\n\n###Validations\nBefore a delete vaulted shopper request is approved, BlueSnap will verify the following:\n  * The shopper has not already been deleted\n  * The shopper does not have any transactions from the past 12 months\n  * The shopper does not have any active subscriptions\n  * The shopper does not have any pending ECP or SEPA payments \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Deleted Shopper Data\",\n  \"body\": \"Please note that any deleted shopper or shopper data will be masked in reports that include that information.\"\n}\n[/block]\n<hr>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --location -g --request DELETE 'https://{URL}/services/2/vaulted-shoppers/19569096' \\\\\\n--header 'Content-Transfer-Encoding: application/json'\",\n      \"language\": \"curl\",\n      \"name\": \"Delete Vaulted Shopper Request with Vaulted Shopper ID\"\n    },\n    {\n      \"code\": \"curl --location -g --request DELETE 'https://{URL}/services/2/vaulted-shoppers/merchant/abc123test' \\\\\\n--header 'Content-Transfer-Encoding: application/json'\",\n      \"language\": \"curl\",\n      \"name\": \"Delete Vaulted Shopper Request with Merchant Shopper ID\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"description\\\": \\\"Your request to delete shopper ID 19570408 has been received and will be processed within 7 days.\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Delete Vaulted Shopper Response: 200 OK\"\n    }\n  ]\n}\n[/block]\n\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n<hr>\n\n##Example Descriptions\n\n###Basic Delete Vaulted Shopper\nThis example shows a basic Delete Vaulted Shopper request that deletes the shopper in BlueSnap. Note that no content is required in the request body. The deletion is based on the vaulted shopper ID in the request URL.\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, 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.\n[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]","updates":[],"order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"61a51e4adca83b015f8acb9d","createdAt":"2021-05-04T16:45:20.246Z","user":"606df105d9ab93003f73cb10","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Vaulted Shoppers","slug":"vaulted-shopper-service","order":10,"from_sync":false,"reference":true,"_id":"61a51e4adca83b015f8acaec","version":"61a51e4adca83b015f8acba4","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2015-10-19T18:31:30.299Z","__v":0},"version":{"version":"8976-JSON","version_clean":"8976.0.0-JSON","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["61a51e4adca83b015f8acae6","61a51e4adca83b015f8acae7","61a51e4adca83b015f8acae8","61a51e4adca83b015f8acae9","61a51e4adca83b015f8acaea","61a51e4adca83b015f8acaeb","61a51e4adca83b015f8acaec","61a51e4adca83b015f8acaed","61a51e4adca83b015f8acaee","61a51e4adca83b015f8acaef","61a51e4adca83b015f8acaf0","61a51e4adca83b015f8acaf1","61a51e4adca83b015f8acaf2","61a51e4adca83b015f8acaf3","61a51e4adca83b015f8acaf4","61a51e4adca83b015f8acaf5","61a51e4adca83b015f8acaf6","61a51e4adca83b015f8acaf7","61a51e4adca83b015f8acaf8","61a51e4adca83b015f8acaf9"],"_id":"61a51e4adca83b015f8acba4","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60fed21a76106200102eaec3","createdAt":"2018-04-24T15:22:41.561Z","releaseDate":"2018-04-24T15:22:41.561Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":12,"parentDoc":null}

deleteDelete Vaulted Shopper


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

vaultedShopperId:
string
vaultedShopperId received from BlueSnap

Documentation

To delete a shopper in BlueSnap, you will perform the Delete Vaulted Shopper request. In order to do this, you need either the BlueSnap token (vaultedShopperId) or the merchantShopperId for your shopper.

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:

Delete 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

Delete 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

A successful response looks like this:
HTTP 200 { "description": "Your request to delete shopper ID 19570408 has been received and will be processed within 7 days." }

Validations

Before a delete vaulted shopper request is approved, BlueSnap will verify the following:

  • The shopper has not already been deleted
  • The shopper does not have any transactions from the past 12 months
  • The shopper does not have any active subscriptions
  • The shopper does not have any pending ECP or SEPA payments

Deleted Shopper Data

Please note that any deleted shopper or shopper data will be masked in reports that include that information.


Examples

Request Examples

curl --location -g --request DELETE 'https://{URL}/services/2/vaulted-shoppers/19569096' \
--header 'Content-Transfer-Encoding: application/json'
curl --location -g --request DELETE 'https://{URL}/services/2/vaulted-shoppers/merchant/abc123test' \
--header 'Content-Transfer-Encoding: application/json'

Response Examples

{
    "description": "Your request to delete shopper ID 19570408 has been received and will be processed within 7 days."
}

Back to Top


Example Descriptions

Basic Delete Vaulted Shopper

This example shows a basic Delete Vaulted Shopper request that deletes the shopper in BlueSnap. Note that no content is required in the request body. The deletion 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.


User Information

Try It Out


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