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.
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."
}
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.