{"_id":"59b6b1edbc195b003ca7a9a8","category":{"_id":"59b6b1ecbc195b003ca7a986","version":"59b6b1ecbc195b003ca7a981","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-17T12:18:27.941Z","from_sync":false,"order":4,"slug":"wallets","title":"Wallets"},"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","parentDoc":null,"version":{"_id":"59b6b1ecbc195b003ca7a981","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2017-09-11T15:55:24.925Z","releaseDate":"2017-09-11T15:55:24.925Z","categories":["59b6b1ecbc195b003ca7a982","59b6b1ecbc195b003ca7a983","59b6b1ecbc195b003ca7a984","59b6b1ecbc195b003ca7a985","59b6b1ecbc195b003ca7a986","59b6b1ecbc195b003ca7a987","59b6b1ecbc195b003ca7a988","59b6b1ecbc195b003ca7a989","59b6b1ecbc195b003ca7a98a","59b6b1ecbc195b003ca7a98b"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.22.2 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-05T15:22:09.082Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"57ee593a21ceb20e0061959e","examples":{"codes":[]},"method":"post","auth":"optional","params":[],"url":""},"isReference":true,"order":19,"body":"##Definition\nhttps://<span>sandbox.bluesnap.com/services/2/wallets/onboarding</span>\n\n<hr>\n\n##Documentation\nThe Onboard Apple Pay request allows you to specify the domains on which you will display the Apple Pay button. To register a new domain in the future, you may perform this request again with the new domain.\n<span></span>\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](/v1.0/docs/apple-pay#section-apple-pay-in-your-website).\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Retrieve onboarding information\",\n  \"body\": \"The first time you send this request, a unique Apple Pay Onboarding ID will be created for your account. You may [retrieve onboarding information](doc:retrieve-apple-pay-onboarding-information) with this ID.\"\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 \nSend a [wallet](/docs/wallet-json) object with the following: \n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`walletType` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`applePay` &nbsp;&nbsp;&nbsp; *object* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>; Contains: \n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`domains` &nbsp;&nbsp;&nbsp; *array* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>&nbsp;&nbsp;&nbsp; Do not include `https://` in the domain name\n\n###JSON Response Details \nIf successful, the response HTTP status code is 201 Created.\nThe Apple Pay Onboarding ID will be returned in the Location header of the response. For example:\nLocation: `https://sandbox.bluesnap.com/services/2/wallets/onboarding/385`\n\n<hr>\n\n##JSON Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/wallets/onboarding \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n{\\n  \\\"walletType\\\": \\\"APPLE_PAY\\\", \\n  \\\"applePay\\\": {\\n    \\t\\\"domains\\\": [\\\"bluesnap.com\\\", \\\"mystore.example.com\\\", \\\"merchant.com\\\"]\\n  }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Onboard Apple Pay\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP 201 Created\\nLocation: https://sandbox.bluesnap.com/services/2/wallets/onboarding/385\",\n      \"language\": \"curl\",\n      \"name\": \"Onboard Apple Pay Response\"\n    }\n  ]\n}\n[/block]\n<hr>\n##Example Descriptions \n###Onboard Apple Pay\nIn this example, we added the three web domains (\"bluesnap.com\", \"mystore.example.com\", and \"merchant.com\") on which we will display the Apple Pay button. The response was successful and contained an Apple Pay Onboarding ID of 385, which we can use to [retrieve onboarding details](doc:retrieve-apple-pay-onboarding-information) later. \n[block:html]\n{\n  \"html\": \" </div>\\n <div id=\\\"menuxml\\\" class=\\\"tab-pane fade\\\">\"\n}\n[/block]\n<br />\n###XML Request Content \nSend a [wallet](/v4.0/docs/wallet) object with the following: \n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`wallet-type` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`apple-pay` &nbsp;&nbsp;&nbsp; *container* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>; Contains: \n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`domain` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>&nbsp;&nbsp;&nbsp; Do not include `https://`\n\n###XML Response Details \nIf successful, the response HTTP status code is 201 Created.\nThe Apple Pay Onboarding ID will be returned in the Location header of the response. For example:\nLocation: `https://sandbox.bluesnap.com/services/2/wallets/onboarding/385`\n\n<hr>\n\n##XML Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/wallets/onboarding \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Accept: application/xml' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<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\": \"curl\",\n      \"name\": \"Onboard Apple Pay\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP 201 Created\\nLocation: https://sandbox.bluesnap.com/services/2/wallets/onboarding/385\",\n      \"language\": \"xml\",\n      \"name\": \"Onboard Apple Pay Response\"\n    }\n  ]\n}\n[/block]\n<hr>\n##Example Descriptions \n###Onboard Apple Pay\nIn this example, we added the three web domains (\"bluesnap.com\", \"mystore.example.com\", and \"merchant.com\") on which we will display the Apple Pay button. The response was successful and contained an Apple Pay Onboarding ID of 385, which we can use to [retrieve onboarding details](doc:retrieve-apple-pay-onboarding-information) later. \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":"onboard-apple-pay-merchant","type":"post","title":"Onboard Apple Pay"}

postOnboard Apple Pay


Definition

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


Documentation

The Onboard Apple Pay request allows you to specify the domains on which you will display the Apple Pay button. To register a new domain in the future, you may perform this request again with the new domain.

This API call is supported for Apple Pay on the web. For more detailed setup instructions, see Apple Pay in your website.

Retrieve onboarding information

The first time you send this request, a unique Apple Pay Onboarding ID will be created for your account. You may retrieve onboarding information with this ID.