Retrieve Wallet · Developer Hub

{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"optional","results":{"codes":[{"language":"text","code":""}]},"settings":"","examples":{"codes":[]},"method":"get","params":[]},"next":{"description":"","pages":[]},"title":"Retrieve Wallet","type":"endpoint","slug":"retrieve-wallet","excerpt":"","body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/wallets/:walletid</span>\n\n<hr>\n\n##Documentation\nThe Retrieve Wallet request retrieves the details for the shopper's wallet, including the credit card's last four digits, shipping and contact info, etc.\n[block:callout]\n{\n \"type\": \"success\",\n \"body\": \"The Retrieve Wallet request is supported for Masterpass and Visa Checkout.\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"The `wallet` resource for a specific wallet ID can only be retrieved within 15 minutes from its creation.\",\n \"title\": \"Wallet expiration\"\n}\n[/block]\n\n[block:html]\n{\n \"html\": \"<ul class=\\\"nav nav-pills nav-justified\\\">\\n <li class=\\\"active\\\"><a data-toggle=\\\"pill\\\" href=\\\"#menujson\\\">JSON</a></li>\\n <li><a data-toggle=\\\"tab\\\" href=\\\"#menuxml\\\">XML</a></li>\\n</ul>\\n<div class=\\\"tab-content\\\">\\n <div id=\\\"menujson\\\" class=\\\"tab-pane fade in active\\\">\"\n}\n[/block]\n###JSON Request Content\nEnter the `walletId` into the web service URL, in the format:\n`services/2/wallets/{walletId}`\n\nFor example:\n`services/2/wallets/1234567`\n\n###JSON Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `wallet` object (see [wallet (JSON object)](doc:wallet-json)).\n\n<hr>\n\n##JSON Examples\n\n###Request Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/wallets/1234567 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Wallet Request\"\n }\n ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"country\\\": \\\"us\\\",\\n \\\"firstName\\\": \\\"FirstName\\\",\\n \\\"lastName\\\": \\\"LastName\\\",\\n \\\"billingContactInfo\\\": {\\n \\\"zip\\\": \\\"zip\\\",\\n \\\"country\\\": \\\"country\\\",\\n \\\"address2\\\": \\\"line2 + line3\\\",\\n \\\"city\\\": \\\"city\\\",\\n \\\"address1\\\": \\\"line1\\\",\\n \\\"state\\\": \\\"state\\\"\\n },\\n \\\"phone\\\": \\\"1-9871111111\\\",\\n \\\"shippingContactInfo\\\": {\\n \\\"zip\\\": \\\"zip\\\",\\n \\\"country\\\": \\\"country\\\",\\n \\\"firstName\\\": \\\"recipient\\\",\\n \\\"lastName\\\": \\\"name\\\",\\n \\\"address2\\\": \\\"line2 + line3\\\",\\n \\\"city\\\": \\\"city\\\",\\n \\\"phone\\\": \\\"recipient phone number\\\",\\n \\\"address1\\\": \\\"line1\\\",\\n \\\"state\\\": \\\"state\\\"\\n },\\n \\\"creditCard\\\": {\\n \\\"expirationYear\\\": 2022,\\n \\\"cardLastFourDigits\\\": \\\"0026\\\",\\n \\\"cardFingerprint\\\": \\\"a0f6043de947e...\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\",\\n \\\"cardType\\\": \\\"VISA\\\",\\n \\\"cardSubType\\\": \\\"CREDIT\\\", \\n \\t\\\"cardCategory\\\": \\\"CLASSIC\\\",\\n \\\"expirationMonth\\\": 2\\n },\\n \\\"email\\\": \\\"joe.test:::at:::email.com\\\"\\n}\",\n \"language\": \"json\",\n \"name\": \"Retrieve Wallet Response: 200 OK\"\n }\n ]\n}\n[/block]\n\n[block:html]\n{\n \"html\": \" </div>\\n <div id=\\\"menuxml\\\" class=\\\"tab-pane fade\\\">\"\n}\n[/block]\n###XML Request Content\nEnter the `wallet-id` into the web service URL, in the format:\n`services/2/wallets/{wallet-id}`\n\nFor example:\n`services/2/wallets/1234567`\n\n###XML Response Details\nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved `wallet` resource (see [wallet (XML resource)](doc:wallet)).\n\n<hr>\n\n##XML Examples\n\n###Request Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/wallets/1234567 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Wallet Request\"\n }\n ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<wallet xmlns=\\\"http://ws.plimus.com\\\">\\n <first-name>FirstName</first-name>\\n <last-name>LastName</last-name>\\n <email>[email protected]</email> \\n <country>us</country>\\n <phone>1-9871111111</phone>\\n <credit-card>\\n <card-last-four-digits>0026</card-last-four-digits>\\n <card-type>VISA</card-type>\\n <card-sub-type>CREDIT</card-sub-type>\\n <card-category>CLASSIC</card-category>\\n <card-fingerprint>a0f6043de947e...</card-fingerprint>\\n <expiration-month>2</expiration-month>\\n <expiration-year>2022</expiration-year>\\n </credit-card>\\n <billing-contact-info>\\n <address1>line1</address1>\\n <address2>line2 + line3</address2>\\n <city>city</city>\\n <state>state</state>\\n <zip>zip</zip>\\n <country>country</country>\\n </billing-contact-info>\\n <shipping-contact-info>\\n <first-name>recipient</first-name>\\n <last-name>name</last-name>\\n <address1>line1</address1>\\n <address2>line2 + line3</address2>\\n <city>city</city>\\n <state>state</state>\\n <zip>zip</zip>\\n <country>country</country>\\n <phone>recipient phone number</phone>\\n </shipping-contact-info>\\n</wallet>\",\n \"language\": \"xml\",\n \"name\": \"Retrieve Wallet Response: 200 OK\"\n }\n ]\n}\n[/block]\n\n[block:html]\n{\n \"html\": \" </div>\\n</div>\"\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f4d276c4ff932005f3e3b5a","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Wallets","slug":"wallets","order":17,"from_sync":false,"reference":true,"_id":"5f4d276b4ff932005f3e3b38","version":"5f4d276c4ff932005f3e3b86","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-05-17T12:18:27.941Z","__v":0},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.35 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f4d276b4ff932005f3e3b33","5f4d276b4ff932005f3e3b34","5f4d276b4ff932005f3e3b35","5f4d276b4ff932005f3e3b36","5f4d276b4ff932005f3e3b37","5f4d276b4ff932005f3e3b38","5f4d276b4ff932005f3e3b39","5f4d276b4ff932005f3e3b3a","5f4d276b4ff932005f3e3b3b","5f4d276b4ff932005f3e3b3c","5f4d276b4ff932005f3e3b3d","5f4d276b4ff932005f3e3b3e","5b34c737e0dca2000311de6a","5f4d276b4ff932005f3e3b3f","5f4d276b4ff932005f3e3b40","5f4d276b4ff932005f3e3b41","5f4d276b4ff932005f3e3b42","5f4d2af1ca14ec003918818c","5f4e66c5c9098e01d05608cf"],"_id":"5f4d276c4ff932005f3e3b86","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5f076ef5f118570458067d0f","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"createdAt":"2016-05-17T13:12:59.918Z","githubsync":"","__v":0}

Definition

https://sandbox.bluesnap.com/services/2/wallets/:walletid

Documentation

The Retrieve Wallet request retrieves the details for the shopper's wallet, including the credit card's last four digits, shipping and contact info, etc.

The Retrieve Wallet request is supported for Masterpass and Visa Checkout.

Wallet expiration

The wallet resource for a specific wallet ID can only be retrieved within 15 minutes from its creation.

JSON
XML

JSON Request Content

Enter the walletId into the web service URL, in the format:
services/2/wallets/{walletId}

For example:
services/2/wallets/1234567

JSON Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved wallet object (see wallet (JSON object)).

JSON Examples

Request Example

Retrieve Wallet Request

curl -v -X GET https://sandbox.bluesnap.com/services/2/wallets/1234567 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Example

Retrieve Wallet Response: 200 OK

{
    "country": "us",
    "firstName": "FirstName",
    "lastName": "LastName",
    "billingContactInfo": {
        "zip": "zip",
        "country": "country",
        "address2": "line2 + line3",
        "city": "city",
        "address1": "line1",
        "state": "state"
    },
    "phone": "1-9871111111",
    "shippingContactInfo": {
        "zip": "zip",
        "country": "country",
        "firstName": "recipient",
        "lastName": "name",
        "address2": "line2 + line3",
        "city": "city",
        "phone": "recipient phone number",
        "address1": "line1",
        "state": "state"
    },
    "creditCard": {
        "expirationYear": 2022,
        "cardLastFourDigits": "0026",
        "cardFingerprint": "a0f6043de947e...",
        "cardSubType": "CREDIT",
        "cardType": "VISA",
        "cardSubType": "CREDIT", 
      	"cardCategory": "CLASSIC",
        "expirationMonth": 2
    },
    "email": "[email protected]"
}

XML Request Content

Enter the wallet-id into the web service URL, in the format:
services/2/wallets/{wallet-id}

For example:
services/2/wallets/1234567

XML Response Details

If successful, the response HTTP status code is 200 OK.
The response contains the retrieved wallet resource (see wallet (XML resource)).

XML Examples

Request Example

Retrieve Wallet Request

curl -v -X GET https://sandbox.bluesnap.com/services/2/wallets/1234567 \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Example

Retrieve Wallet Response: 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<wallet xmlns="http://ws.plimus.com">
  <first-name>FirstName</first-name>
  <last-name>LastName</last-name>
  <email>[email protected]</email>   
  <country>us</country>
  <phone>1-9871111111</phone>
  <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>
    <card-fingerprint>a0f6043de947e...</card-fingerprint>
    <expiration-month>2</expiration-month>
    <expiration-year>2022</expiration-year>
  </credit-card>
  <billing-contact-info>
    <address1>line1</address1>
    <address2>line2 + line3</address2>
    <city>city</city>
    <state>state</state>
    <zip>zip</zip>
    <country>country</country>
  </billing-contact-info>
  <shipping-contact-info>
    <first-name>recipient</first-name>
    <last-name>name</last-name>
    <address1>line1</address1>
    <address2>line2 + line3</address2>
    <city>city</city>
    <state>state</state>
    <zip>zip</zip>
    <country>country</country>
    <phone>recipient phone number</phone>
  </shipping-contact-info>
</wallet>

Developer Hub

BlueSnap Reporting & Tools

Reporting API

3D Secure

Account Updater

Bank Directory

Convert Currency

Embedded Checkout

Encrypt/Decrypt Parameters

Hosted Payment Fields

Logos & Images

Payment Request Button

Retrieve Card Info

Retrieve Payment Methods

Secured Payment Collector

SEPA Direct Debit

User Management

Wallets

getRetrieve Wallet

Definition

Documentation

Wallet expiration

JSON Request Content

JSON Response Details

JSON Examples

Request Example

Response Example

XML Request Content

XML Response Details

XML Examples

Request Example

Response Example