{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Installing Wyre Checkout","type":"basic","slug":"wyre-checkout-installation","excerpt":"","body":"[block:api-header]\n{\n  \"title\": \"Overview\"\n}\n[/block]\nThe Wyre Checkout may be loaded on a page or in a browser dialog. As a partner developer, you will not have direct access to the customer's personal information. The underlying personal information is exposed only in response to demands made to Wyre lawfully (or, in some cases, in support of **security** authorization).\n\n## Apple pay will only work in hosted mode inside Safari web view. \n\n[block:api-header]\n{\n  \"title\": \"Wyre Checkout Installation\"\n}\n[/block]\nThe Wyre Checkout can be instantiated in two different ways:\n- A Wyre-branded card payment processing flow as a popup [Wyre Checkout - Hosted Dialog](doc:wyre-checkout-hosted-dialog) \n- A full-featured, Wyre-branded Debit Card payment processing flow, hosted by Wyre [Wyre Checkout - Hosted URL](doc:wyre-widget-v2) \n\n\n[block:api-header]\n{\n  \"title\": \"Retrieving Order and Transfer Updates\"\n}\n[/block]\nWhen the Wallet Order is created, it will be processed and the order data can be found by calling GET `/v3/order/:orderId`. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"WO_ELTUVYCAFPG\\\", --> waller order id\\n    \\\"createdAt\\\": 1576263687643,  -- timestamp in UTC\\n    \\\"owner\\\": \\\"account:AC_RNWQNRAZFPC\\\", --> owner \\n    \\\"status\\\": \\\"RUNNING_CHECKS\\\",\\n    \\\"sourceAmount\\\": 1.84,\\n    \\\"sourceCurrency\\\": \\\"USD\\\",\\n    \\\"destCurrency\\\": \\\"ETH\\\",\\n    \\\"dest\\\": \\\"ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341\\\",\\n    \\\"walletType\\\": \\\"APPLE_PAY\\\",\\n    \\\"transferId\\\": null,\\n    \\\"errorMessage\\\": null,\\n    \\\"accountId\\\": \\\"AC_RNWQNRAZFPC\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nThe [Order Processing Status](doc:wallet-order-processing) change over time and once the status is `COMPLETE` or `PROCESSING` you can fetch the blockchain transaction info here [Track Widget Order](doc:track-wallet-order). \n\n[block:api-header]\n{\n  \"title\": \"Wallet Order Webhook\"\n}\n[/block]\n\nYou can also get order status update via Webhooks by registering the Webhook (with sales team sales:::at:::sendwyre.com). \nAsk the Wyre Sales team to register your webhook URL by providing them your `accountId` and the `url`.  This configuration is per environment. \n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`referenceId`\",\n    \"0-1\": \"Your own internal reference id.\",\n    \"0-2\": \"String, optional\",\n    \"h-2\": \"Required\",\n    \"h-1\": \"Description\",\n    \"h-0\": \"Parameter\",\n    \"1-0\": \"`accountId`\",\n    \"1-1\": \"Your Wyre account id.\",\n    \"1-2\": \"String, required for the webhook to work.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\nThe webhook will be called for any state change in orders which were submitted with an `accountId`\nthat has a webhook URL configured. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" \\n{\\n  \\\"referenceId\\\":\\\"your_reference_id\\\", // your own id passed in the order creation\\n   \\\"accountId\\\":\\\"AAAAAAAAAAA\\\", // your Wyre account id\\n   \\\"orderId\\\":\\\"WO_0000000001\\\", // the wallet order id\\n   \\\"orderStatus\\\":\\\"PROCESSING\\\", // the order status {PROCESSING, COMPLETE, FAILED}]\\n   \\\"transferId\\\":\\\"TF_000000001\\\", // OPTIONAL, available when order was completed,  the transfer id\\n   \\\"failedReason\\\":\\\" OPTIONAL,  some string with failed reason\\\" // if failed, there should be a reason string when possible\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Webhook response\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Test Cards & Supported Types\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"5555555555554444\",\n    \"0-1\": \"Mastercard + Visa\",\n    \"1-0\": \"Expiration Date 10/23    CVV 123\",\n    \"1-1\": \"Applepay + Debit Card 3DS\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Go Live\"\n}\n[/block]\nBefore going live, you'll want to make sure that you:\n\n- Finalize your Partnership Agreement with Wyre\n- Create your production Wyre account and complete KYC\n- Configure the Widget for the `production` environment\n\nThat's it! You're now ready to accept confidently verified users into your application's ecosystem.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Apple pay will only work in hosted mode inside Safari and some Opera browsers.\",\n  \"title\": \"Warning\"\n}\n[/block]","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f2db3e930f2db002c8a32b5","createdAt":"2020-08-07T20:04:57.686Z","user":"5dcd9f0b28d74f003b86eca6","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Wyre Checkout","slug":"wyre-sdk","order":2,"from_sync":false,"reference":true,"_id":"5bc63538e5a6ba000d22ee6d","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-10-16T19:00:08.331Z","__v":1},"version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded","5e8127d61c906800374eeb1c","5f2768c98622b8005106544a","5f2768d05702ca0011f7655e","5f276e5348d2b600321aef9b","5f276fd300e519001139200a"],"_id":"550f75de61d9d30d00af9e01","__v":22,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":0,"parentDoc":null}

Installing Wyre Checkout


[block:api-header] { "title": "Overview" } [/block] The Wyre Checkout may be loaded on a page or in a browser dialog. As a partner developer, you will not have direct access to the customer's personal information. The underlying personal information is exposed only in response to demands made to Wyre lawfully (or, in some cases, in support of **security** authorization). ## Apple pay will only work in hosted mode inside Safari web view. [block:api-header] { "title": "Wyre Checkout Installation" } [/block] The Wyre Checkout can be instantiated in two different ways: - A Wyre-branded card payment processing flow as a popup [Wyre Checkout - Hosted Dialog](doc:wyre-checkout-hosted-dialog) - A full-featured, Wyre-branded Debit Card payment processing flow, hosted by Wyre [Wyre Checkout - Hosted URL](doc:wyre-widget-v2) [block:api-header] { "title": "Retrieving Order and Transfer Updates" } [/block] When the Wallet Order is created, it will be processed and the order data can be found by calling GET `/v3/order/:orderId`. [block:code] { "codes": [ { "code": "{\n \"id\": \"WO_ELTUVYCAFPG\", --> waller order id\n \"createdAt\": 1576263687643, -- timestamp in UTC\n \"owner\": \"account:AC_RNWQNRAZFPC\", --> owner \n \"status\": \"RUNNING_CHECKS\",\n \"sourceAmount\": 1.84,\n \"sourceCurrency\": \"USD\",\n \"destCurrency\": \"ETH\",\n \"dest\": \"ethereum:0x9E01E0E60dF079136a7a1d4ed97d709D5Fe3e341\",\n \"walletType\": \"APPLE_PAY\",\n \"transferId\": null,\n \"errorMessage\": null,\n \"accountId\": \"AC_RNWQNRAZFPC\"\n}", "language": "json" } ] } [/block] The [Order Processing Status](doc:wallet-order-processing) change over time and once the status is `COMPLETE` or `PROCESSING` you can fetch the blockchain transaction info here [Track Widget Order](doc:track-wallet-order). [block:api-header] { "title": "Wallet Order Webhook" } [/block] You can also get order status update via Webhooks by registering the Webhook (with sales team [email protected]). Ask the Wyre Sales team to register your webhook URL by providing them your `accountId` and the `url`. This configuration is per environment. [block:parameters] { "data": { "0-0": "`referenceId`", "0-1": "Your own internal reference id.", "0-2": "String, optional", "h-2": "Required", "h-1": "Description", "h-0": "Parameter", "1-0": "`accountId`", "1-1": "Your Wyre account id.", "1-2": "String, required for the webhook to work." }, "cols": 3, "rows": 2 } [/block] The webhook will be called for any state change in orders which were submitted with an `accountId` that has a webhook URL configured. [block:code] { "codes": [ { "code": " \n{\n \"referenceId\":\"your_reference_id\", // your own id passed in the order creation\n \"accountId\":\"AAAAAAAAAAA\", // your Wyre account id\n \"orderId\":\"WO_0000000001\", // the wallet order id\n \"orderStatus\":\"PROCESSING\", // the order status {PROCESSING, COMPLETE, FAILED}]\n \"transferId\":\"TF_000000001\", // OPTIONAL, available when order was completed, the transfer id\n \"failedReason\":\" OPTIONAL, some string with failed reason\" // if failed, there should be a reason string when possible\n}", "language": "json", "name": "Webhook response" } ] } [/block] [block:api-header] { "title": "Test Cards & Supported Types" } [/block] [block:parameters] { "data": { "0-0": "5555555555554444", "0-1": "Mastercard + Visa", "1-0": "Expiration Date 10/23 CVV 123", "1-1": "Applepay + Debit Card 3DS" }, "cols": 2, "rows": 2 } [/block] [block:api-header] { "title": "Go Live" } [/block] Before going live, you'll want to make sure that you: - Finalize your Partnership Agreement with Wyre - Create your production Wyre account and complete KYC - Configure the Widget for the `production` environment That's it! You're now ready to accept confidently verified users into your application's ecosystem. [block:callout] { "type": "warning", "body": "Apple pay will only work in hosted mode inside Safari and some Opera browsers.", "title": "Warning" } [/block]