{"_id":"5b197473be7bb50003d5dbc3","category":{"_id":"5b197473be7bb50003d5dba1","version":"5b197473be7bb50003d5dbd6","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T12:18:27.941Z","from_sync":false,"order":12,"slug":"wallets","title":"Wallets"},"project":"57336fd5a6a9c40e00e13a0b","parentDoc":null,"user":"560d5913af97231900938124","version":{"_id":"5b197473be7bb50003d5dbd6","project":"57336fd5a6a9c40e00e13a0b","__v":2,"forked_from":"5addf90f94fe9d0003cd9d29","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z","categories":["5b197473be7bb50003d5db9c","5b197473be7bb50003d5db9d","5b197473be7bb50003d5db9e","5b197473be7bb50003d5db9f","5b197473be7bb50003d5dba0","5b197473be7bb50003d5dba1","5b197473be7bb50003d5dba2","5b197473be7bb50003d5dba3","5b197473be7bb50003d5dba4","5b197473be7bb50003d5dba5","5b197473be7bb50003d5dba6","5b27bded4799c70003f36389","5b34c737e0dca2000311de6a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.26 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-05T15:35:07.167Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":true,"order":4,"body":"##Definition\nhttps://<span>sandbox.bluesnap.com/services/2/wallets/onboarding/:onboardingId</span>\n\n<hr>\n\n##Documentation\nThis GET request allows you to retrieve the registered domains on which you are displaying the Apple Pay button.\n[block:callout]\n{\n \"type\": \"success\",\n \"body\": \"This API call is supported for Apple Pay on the web. For more detailed setup instructions, see [Apple Pay in your website](/docs/apple-pay#section-apple-pay-in-your-website).\"\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<br />\n###JSON Request Content\nEnter the Onboarding ID into the web service URL, in the format:\n`services/2/wallets/onboarding/{onboardingId}`\n\nFor example:\n`services/2/wallets/onboarding/365`\n\n###JSON Response Details \nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved [`wallet`](doc:wallet-json) object. \n\n<hr> \n\n##JSON Examples \n###Request Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/wallets/onboarding/365 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Onboarding Information Request\"\n }\n ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"walletType\\\": \\\"APPLE_PAY\\\", \\n \\\"applePay\\\": {\\n \\t\\\"domains\\\": [\\\"bluesnap.com\\\", \\\"mystore.example.com\\\", \\\"merchant.com\\\"]\\n }\\n}\",\n \"language\": \"json\",\n \"name\": \"Retreive Onboarding Information Response: 200 OK\"\n }\n ]\n}\n[/block]\n\n<hr>\n\n##Example Descriptions\n###Retrieve Onboarding Information\nBy including our Onboarding ID of 365 in the request URL, we obtained a list of registered domains in the response. \n[block:html]\n{\n \"html\": \" </div>\\n <div id=\\\"menuxml\\\" class=\\\"tab-pane fade\\\">\"\n}\n[/block]\n<br />\n###XML Request Content\nEnter the Onboarding ID into the web service URL, in the format:\n`services/2/wallets/onboarding/{onboarding-id}`\n\nFor example:\n`services/2/wallets/onboarding/365`\n\n###XML Response Details \nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved [`wallet`](doc:wallet) resource. \n\n<hr> \n\n##XML Examples\n###Request Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/wallets/onboarding/365 \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Accept: application/xml' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Onboarding Information Request\"\n }\n ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<wallet xmlns=\\\"http://ws.plimus.com\\\">\\n <wallet-type>APPLE_PAY</wallet-type>\\n <apple-pay>\\n <domain>bluesnap.com</domain>\\n <domain>mystore.example.com</domain>\\n <domain>merchant.com</domain>\\n </apple-pay>\\n</wallet>\",\n \"language\": \"xml\",\n \"name\": \"Retrieve Onboarding Information: 200 OK\"\n }\n ]\n}\n[/block]\n\n<hr>\n\n##Example Descriptions\n###Retrieve Onboarding Information\nBy including our Onboarding ID of 365 in the request URL, we obtained a list of registered domains in the response.\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>","excerpt":"","slug":"retrieve-apple-pay-onboarding-information","type":"endpoint","title":"Retrieve Apple Pay Onboarding Information"}getRetrieve Apple Pay Onboarding Information
This API call is supported for Apple Pay on the web. For more detailed setup instructions, see Apple Pay in your website.