{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[],"examples":{"codes":[]},"method":"put"},"next":{"description":"","pages":[]},"title":"Update Apple Pay Onboarding Information","type":"endpoint","slug":"update-apple-pay-onboarding-information","excerpt":"","body":"##Definition\nhttps://<span>sandbox.bluesnap.com/services/2/wallets/onboarding</span>\n\n<hr>   \n\n##Documentation\nThe Update Apple Pay Onboarding Information request allows you to register a new domain that will display the Apple Pay button or to unregister an existing 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](/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 \nSend a [wallet](doc: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;Optional&nbsp;&nbsp;&nbsp; Do not include `https://` in the domain name\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`unregisterDomains` &nbsp;&nbsp;&nbsp; *array* &nbsp;&nbsp;&nbsp;Optional&nbsp;&nbsp;&nbsp; Do not include `https://` in the domain name\n\n###JSON Response Details \nIf successful, the response HTTP status code is 200 OK and the body contains an array of currently registered domains. \n\n<hr>\n\n##JSON Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X PUT 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    \\\"domains\\\": [\\\"test4.bluesnap.com\\\"]\\n  }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Register new domain\"\n    },\n    {\n      \"code\": \"curl -v -X PUT 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    \\\"unregisterDomains\\\": [\\n      \\\"test2.bluesnap.com\\\",\\n      \\\"test3.bluesnap.com\\\"\\n    ]\\n  }\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"Unregister domain\"\n    }\n  ]\n}\n[/block]\n###Response Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"walletType\\\": \\\"APPLE_PAY\\\",\\n  \\\"applePay\\\": {\\n    \\\"domains\\\": [\\\"test1.bluesnap.com\\\", \\\"test4.bluesnap.com\\\"]\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ]\n}\n[/block]\n<hr>\n##Example Descriptions \n\n###Register new domain\nIn this example, we registered a new domain, `test4.bluesnap.com`, that will display the Apple Pay button. \n\n### Unregister existing domain \nIn this example, we unregistered two domains, `test2.bluesnap.com` and `test3.bluesnap.com`. \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](doc:wallet) resource 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;Optional&nbsp;&nbsp;&nbsp; Do not include `https://` in the domain name\n\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`unregister-domain` &nbsp;&nbsp;&nbsp; *string* &nbsp;&nbsp;&nbsp;Optional&nbsp;&nbsp;&nbsp; Do not include `https://` in the domain name\n\n###XML Response Details \nIf successful, the response HTTP status code is 200 OK and the body contains the currently registered domains. \n\n<hr>\n\n##XML Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X PUT 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>test4.bluesnap.com</domain>\\n  </apple-pay>\\n</wallet>'\",\n      \"language\": \"curl\",\n      \"name\": \"Register new domain\"\n    },\n    {\n      \"code\": \"curl -v -X PUT 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    <unregister-domain>test2.bluesnap.com</unregister-domain>\\n    <unregister-domain>test3.bluesnap.com</unregister-domain>\\n  </apple-pay>\\n</wallet>'\",\n      \"language\": \"curl\",\n      \"name\": \"Unregister domain\"\n    }\n  ]\n}\n[/block]\n###Response Examples\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>test1.bluesnap.com</domain>\\n    <domain>test4.bluesnap.com</domain>\\n  </apple-pay>\\n</wallet>\",\n      \"language\": \"xml\",\n      \"name\": \"Onboard Apple Pay Response\"\n    }\n  ]\n}\n[/block]\n<hr>\n##Example Descriptions \n\n###Register new domain\nIn this example, we registered a new domain, `test4.bluesnap.com`, that will display the Apple Pay button. \n\n### Unregister existing domain \nIn this example, we unregistered two domains: `test2.bluesnap.com` and `test3.bluesnap.com`. \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":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f076fec0165f6045532161c","createdAt":"2020-07-09T19:28:44.227Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Wallets","slug":"wallets","order":15,"from_sync":false,"reference":true,"_id":"5f076ef5f118570458067cc5","version":"5f076ef5f118570458067d0f","project":"57336fd5a6a9c40e00e13a0b","createdAt":"2016-05-17T12:18:27.941Z","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.34.2 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f076ef5f118570458067cc0","5f076ef5f118570458067cc1","5f076ef5f118570458067cc2","5f076ef5f118570458067cc3","5f076ef5f118570458067cc4","5f076ef5f118570458067cc5","5f076ef5f118570458067cc6","5f076ef5f118570458067cc7","5f076ef5f118570458067cc8","5f076ef5f118570458067cc9","5f076ef5f118570458067cca","5f076ef5f118570458067ccb","5b34c737e0dca2000311de6a","5f076ef5f118570458067ccc","5f076ef5f118570458067ccd","5f076ef5f118570458067cce","5f1f0388102a1500503c17b3"],"_id":"5f076ef5f118570458067d0f","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5ecfffa62b00c0001886626b","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

putUpdate Apple Pay Onboarding Information


Definition

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


Documentation

The Update Apple Pay Onboarding Information request allows you to register a new domain that will display the Apple Pay button or to unregister an existing domain.

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