Retrieve Vaulted Shopper

The Retrieve Vaulted Shopper request retrieves all the saved details for the shopper associated with the BlueSnap token (vaultedShopperId) 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 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

Retrieve Vaulted Shopper with Vaulted Shopper ID

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 '

Retrieve Vaulted Shopper with Merchant Shopper ID

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 '

Response Example

Retrieve Vaulted Shopper with Vaulted Shopper ID Response: 200 OK

{
  "paymentSources": {
    "creditCardInfo": [
      {
        "billingContactInfo": {
          "firstName": "FirstName",
          "lastName": "LastName"
        },
        "processingInfo": {
          "avsResponseCodeAddress": "U",
          "cvvResponseCode": "ND",
          "avsResponseCodeName": "U",
          "avsResponseCodeZip": "U"
        },
        "creditCard": {
          "expirationYear": 2023,
          "cardLastFourDigits": "0026",
          "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"
}

with Merchant Shopper ID Response: 200 OK

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

with Multiple ACH: 200 OK

{
  "vaultedShopperId": 19569754,
  "firstName": "FirstName",
  "lastName": "LastName",
  "country": "us",
  "zip": "02453",
  "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.