Retrieve Vaulted Shopper

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


📘

Tip

You can test out a request that hits our sandbox in real-time. Follow the instructions here to use the "Try It!" feature on the right side.

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).

Note: Non-reusable cards, like gift cards, will not be returned as payment sources.


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

<?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>2023</expiration-year>
      </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>
      <date-created>09/30/2020</date-created>
      <time-created>05:59:40</time-created>
    </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>
  <date-created>09/22/2020</date-created>
  <time-created>13:41:10</time-created>
</vaulted-shopper>
<?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>2023</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>
      <date-created>09/30/2020</date-created>
      <time-created>05:59:40</time-created>
    </credit-card-info>
  </payment-sources>
  <date-created>09/22/2020</date-created>
  <time-created>13:41:10</time-created>
</vaulted-shopper>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vaulted-shopper xmlns="http://ws.plimus.com">
  <vaulted-shopper-id>19569754</vaulted-shopper-id>
  <first-name>FirstName</first-name>
  <last-name>LastName</last-name>
  <country>us</country>
  <zip>12345</zip>
  <phone>1234567890</phone>
  <shopper-currency>USD</shopper-currency>
  <payment-sources>
    <ecp-details>
      <billing-contact-info>
        <first-name>FirstName</first-name>
        <last-name>LastName</last-name>
      </billing-contact-info>
      <ecp>
        <account-type>CONSUMER_CHECKING</account-type>
        <public-account-number>99992</public-account-number>
        <public-routing-number>75150</public-routing-number>
      </ecp>
      <date-created>09/30/2020</date-created>
      <time-created>05:59:40</time-created>
    </ecp-details>
    <ecp-details>
      <billing-contact-info>
        <first-name>FirstName</first-name>
        <last-name>LastName</last-name>
      </billing-contact-info>
      <ecp>
        <account-type>CONSUMER_SAVINGS</account-type>
        <public-account-number>99993</public-account-number>
        <public-routing-number>75151</public-routing-number>
      </ecp>
      <date-created>09/30/2020</date-created>
      <time-created>05:48:18</time-created>
    </ecp-details>
  </payment-sources>
  <date-created>09/22/2020</date-created>
  <time-created>13:41:10</time-created>
</vaulted-shopper>

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.

Language
Authentication
Header
Click Try It! to start a request and see the response here!