{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Wallet Order Webhooks","type":"basic","slug":"wallet-order-webhooks","excerpt":"Get order status updates without polling","body":"Wallet Order Webhooks are different than our Data Subscription Webhooks. Ask the Wyre Sales team to register your Wallet Order Webhook URL by providing them your `accountId` and the `url`. \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Wallet Order Webhooks\"\n}\n[/block]\nYou can get order status update via Webhooks by registering the Webhook (with sales team sales:::at:::sendwyre.com). This configuration is per environment (test & production). \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required\",\n    \"0-0\": \"`referenceId`\",\n    \"0-1\": \"Your own internal reference id.\",\n    \"0-2\": \"String, optional\",\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]\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:api-header]\n{\n  \"title\": \"Wallet Order Webhook Payload\"\n}\n[/block]\nThe `referenceId` is passed within the [Wallet Order Reservation](doc:wallet-order-reservations) request. You decide the referenceId and use it to track your orders.  \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    }\n  ]\n}\n[/block]","updates":[],"order":12,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5faa03635450620019f5a0c3","createdAt":"2020-11-10T03:05:07.377Z","user":"5f7f6ea298ba660011771f74","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Wyre Checkout","slug":"wyre-sdk","order":3,"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","5f9a2cb79dafe500259281a7"],"_id":"550f75de61d9d30d00af9e01","__v":23,"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}

Wallet Order Webhooks

Get order status updates without polling

Wallet Order Webhooks are different than our Data Subscription Webhooks. Ask the Wyre Sales team to register your Wallet Order Webhook URL by providing them your `accountId` and the `url`. [block:api-header] { "type": "basic", "title": "Wallet Order Webhooks" } [/block] You can get order status update via Webhooks by registering the Webhook (with sales team [email protected]). This configuration is per environment (test & production). [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "h-2": "Required", "0-0": "`referenceId`", "0-1": "Your own internal reference id.", "0-2": "String, optional", "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:api-header] { "title": "Wallet Order Webhook Payload" } [/block] The `referenceId` is passed within the [Wallet Order Reservation](doc:wallet-order-reservations) request. You decide the referenceId and use it to track your orders. [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" } ] } [/block]