{"_id":"5cb9f1b5cdbac30062b62fc9","project":"550f74bb6fc8130d0038aad3","version":{"_id":"550f75de61d9d30d00af9e01","__v":17,"project":"550f74bb6fc8130d0038aad3","forked_from":"550f74bb6fc8130d0038aad6","createdAt":"2015-03-23T02:09:34.221Z","releaseDate":"2015-03-23T02:09:34.221Z","categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"5be5d13ff1d319002baca9ce","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2018-11-09T18:26:07.698Z","from_sync":false,"order":0,"slug":"getting-started","title":"Wyre API"},"user":"54eb8076867e1917009b7160","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-19T16:05:09.810Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":11,"body":"The Wyre platform notifies customers of status changes, approvals, rejections, and circumstances that require their attention via email. A description of the range of emails we dispatch to customers is defined in the table below.\n\nCustodialized subaccounts will not in general receive emails. However, all other accounts may receive emails of two variations: emails which are fully and solely Wyre branded, and emails which have partner-specific customization, including the name of partner/application as well as an optional [customizable link](#partner-links). \n\nIn the case where you want our email to open a native application on the customers phone, please use the customizable link as described below and direct the customer to a webserver you control. On this landing page, you may perform the necessary OS detection and redirect them to an appropriately schemed application-specific URI. (Please do not attempt to provide custom-schema URIs directly in the email.)\n[block:api-header]\n{\n  \"title\": \"Outbound Emails\"\n}\n[/block]\nThis table describes all outbound email communication from the Wyre backend. The IDs are useful for interpreting customers redirected via the [partner links](#partner-links).\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`account.approved`\",\n    \"1-0\": \"`account.rejected`\",\n    \"2-0\": \"`account.disabled`\",\n    \"3-0\": \"`account.partially-submitted`\",\n    \"4-0\": \"`account.need-attention`\",\n    \"5-0\": \"`transfer.outgoing`\",\n    \"6-0\": \"`transfer.outgoing-exchange`\",\n    \"7-0\": \"`transfer.outgoing-completed`\",\n    \"8-0\": \"`transfer.outgoing-exchange-completed`\",\n    \"9-0\": \"`transfer.exchange-completed`\",\n    \"10-0\": \"`transfer.withdrawal-completed`\",\n    \"11-0\": \"`transfer.deposit-completed`\",\n    \"12-0\": \"`transfer.incoming-completed`\",\n    \"13-0\": \"`transfer.outgoing-failed`\",\n    \"14-0\": \"`transfer.outgoing-exchange-failed`\",\n    \"15-0\": \"`transfer.exchange-failed`\",\n    \"16-0\": \"`transfer.withdrawal-failed`\",\n    \"17-0\": \"`transfer.deposit-failed`\",\n    \"18-0\": \"`pm.active`\",\n    \"19-0\": \"`pm.pending`\",\n    \"20-0\": \"`pm.rejected`\",\n    \"h-0\": \"Email Identifier\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"\",\n    \"0-1\": \"The account has been approved for transacting\",\n    \"1-1\": \"The account has been rejected due to suspicion of fraud or other compliance red flags\",\n    \"2-1\": \"The account has been disabled at the behest of its owner\",\n    \"3-1\": \"A followup reminder to accounts which have not had all their required documentation submitted\",\n    \"4-1\": \"Attention is required by the customer to submit or re-submit more information\",\n    \"5-1\": \"An outgoing transfer has been initiated from the account\",\n    \"6-1\": \"An outgoing transfer+exchange has been initiated from the account\",\n    \"7-1\": \"An outgoing transfer has been completed successfully\",\n    \"8-1\": \"An outgoing transfer+exchange has been completed successfully\",\n    \"9-1\": \"A currency exchange has been successfully completed\",\n    \"10-1\": \"A withdrawal of funds from the platform has been completed\",\n    \"11-1\": \"An deposit of funds to their account balance has been completed\",\n    \"12-1\": \"Funds have been received from the blockchain or another account\",\n    \"13-1\": \"An outgoing transfer has failed\",\n    \"14-1\": \"An outgoing transfer+exchange has failed\",\n    \"15-1\": \"A currency exchange has failed\",\n    \"16-1\": \"A funds withdrawal has failed\",\n    \"17-1\": \"A deposit of funds has failed\",\n    \"18-1\": \"A linked bank account or card has been activated and is now available for transacting\",\n    \"19-1\": \"A bank account or card has been linked and is being processed\",\n    \"20-1\": \"A bank account or card was unable to be validated and approved for transacting\"\n  },\n  \"cols\": 2,\n  \"rows\": 21\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Partner Links\"\n}\n[/block]\nThe partner links is a button/link included in emails sent to customers in the context of your specific Wyre partner/application. If you do not provide us with such a link, the emails contain only language notifying the customer of the state, but offer no call-to-action.\n\nPresently, you must [contact support](https://support.sendwyre.com) to provide us with the link that will be embedded within these emails. We append a set of query parameters to this link to help inform your systems of the context surrounding the link.\n\nThese query parameters are as follows:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`accountId`\",\n    \"1-0\": \"`transferId`\",\n    \"h-1\": \"Info\",\n    \"h-0\": \"Parameter\",\n    \"0-1\": \"The Wyre account ID involved. This is generally present on all links.\",\n    \"1-1\": \"The ID of the Wyre transfer which prompted the email. This will be present for all `transfer.*` emails\",\n    \"2-0\": \"`paymentMethodId`\",\n    \"3-0\": \"`email` \\n\\n_coming soon_\",\n    \"2-1\": \"The ID of the Wyre payment method which prompted the email. This will be present for all `pm.*` emails\",\n    \"3-1\": \"Indicative of the email which caused the message. This will be the email identifier from above, such as: `pm.active`, `transfer.outgoing`, etc.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"customer-emails-messaging","type":"basic","title":"Customer Emails & Messaging"}

Customer Emails & Messaging


The Wyre platform notifies customers of status changes, approvals, rejections, and circumstances that require their attention via email. A description of the range of emails we dispatch to customers is defined in the table below. Custodialized subaccounts will not in general receive emails. However, all other accounts may receive emails of two variations: emails which are fully and solely Wyre branded, and emails which have partner-specific customization, including the name of partner/application as well as an optional [customizable link](#partner-links). In the case where you want our email to open a native application on the customers phone, please use the customizable link as described below and direct the customer to a webserver you control. On this landing page, you may perform the necessary OS detection and redirect them to an appropriately schemed application-specific URI. (Please do not attempt to provide custom-schema URIs directly in the email.) [block:api-header] { "title": "Outbound Emails" } [/block] This table describes all outbound email communication from the Wyre backend. The IDs are useful for interpreting customers redirected via the [partner links](#partner-links). [block:parameters] { "data": { "0-0": "`account.approved`", "1-0": "`account.rejected`", "2-0": "`account.disabled`", "3-0": "`account.partially-submitted`", "4-0": "`account.need-attention`", "5-0": "`transfer.outgoing`", "6-0": "`transfer.outgoing-exchange`", "7-0": "`transfer.outgoing-completed`", "8-0": "`transfer.outgoing-exchange-completed`", "9-0": "`transfer.exchange-completed`", "10-0": "`transfer.withdrawal-completed`", "11-0": "`transfer.deposit-completed`", "12-0": "`transfer.incoming-completed`", "13-0": "`transfer.outgoing-failed`", "14-0": "`transfer.outgoing-exchange-failed`", "15-0": "`transfer.exchange-failed`", "16-0": "`transfer.withdrawal-failed`", "17-0": "`transfer.deposit-failed`", "18-0": "`pm.active`", "19-0": "`pm.pending`", "20-0": "`pm.rejected`", "h-0": "Email Identifier", "h-1": "Description", "h-2": "", "0-1": "The account has been approved for transacting", "1-1": "The account has been rejected due to suspicion of fraud or other compliance red flags", "2-1": "The account has been disabled at the behest of its owner", "3-1": "A followup reminder to accounts which have not had all their required documentation submitted", "4-1": "Attention is required by the customer to submit or re-submit more information", "5-1": "An outgoing transfer has been initiated from the account", "6-1": "An outgoing transfer+exchange has been initiated from the account", "7-1": "An outgoing transfer has been completed successfully", "8-1": "An outgoing transfer+exchange has been completed successfully", "9-1": "A currency exchange has been successfully completed", "10-1": "A withdrawal of funds from the platform has been completed", "11-1": "An deposit of funds to their account balance has been completed", "12-1": "Funds have been received from the blockchain or another account", "13-1": "An outgoing transfer has failed", "14-1": "An outgoing transfer+exchange has failed", "15-1": "A currency exchange has failed", "16-1": "A funds withdrawal has failed", "17-1": "A deposit of funds has failed", "18-1": "A linked bank account or card has been activated and is now available for transacting", "19-1": "A bank account or card has been linked and is being processed", "20-1": "A bank account or card was unable to be validated and approved for transacting" }, "cols": 2, "rows": 21 } [/block] [block:api-header] { "title": "Partner Links" } [/block] The partner links is a button/link included in emails sent to customers in the context of your specific Wyre partner/application. If you do not provide us with such a link, the emails contain only language notifying the customer of the state, but offer no call-to-action. Presently, you must [contact support](https://support.sendwyre.com) to provide us with the link that will be embedded within these emails. We append a set of query parameters to this link to help inform your systems of the context surrounding the link. These query parameters are as follows: [block:parameters] { "data": { "0-0": "`accountId`", "1-0": "`transferId`", "h-1": "Info", "h-0": "Parameter", "0-1": "The Wyre account ID involved. This is generally present on all links.", "1-1": "The ID of the Wyre transfer which prompted the email. This will be present for all `transfer.*` emails", "2-0": "`paymentMethodId`", "3-0": "`email` \n\n_coming soon_", "2-1": "The ID of the Wyre payment method which prompted the email. This will be present for all `pm.*` emails", "3-1": "Indicative of the email which caused the message. This will be the email identifier from above, such as: `pm.active`, `transfer.outgoing`, etc." }, "cols": 2, "rows": 4 } [/block]