{"_id":"5bc634421d21bf002f33f56a","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":"5bc633b08c4b0b000d6a7eaa","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2018-10-16T18:53:36.184Z","from_sync":false,"order":7,"slug":"payment-methods","title":"Payment Methods"},"user":"54eb883f4f94620d00789aaa","__v":2,"parentDoc":null,"updates":["5c6c8a83a74d56001373b552","5d2cab1252622e006b2e2b57"],"next":{"pages":[],"description":""},"createdAt":"2018-10-16T18:56:02.693Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","apiSetting":null,"auth":"required","params":[],"url":""},"isReference":true,"order":1,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Payment Method APIs still on v2\",\n  \"body\": \"Please note that we are currently working on upgrading out Payment Method APIs. The APIs  laid out in this document still have API v2 URLs. Our new APIs will include the functionality outlined here as well as additional functionality.\"\n}\n[/block]\n\nPayment Method resources are generic resources that represent a payment method connected to the financial system. \n\nA Payment Method, as returned by the Wyre, looks like this:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"PA-W7YN28ABCHT\\\",\\n    \\\"owner\\\": \\\"account:AC-XX38VYXUA84\\\",\\n    \\\"createdAt\\\": 1542771684392,\\n    \\\"name\\\": \\\"Plaid Checking 0000\\\",\\n    \\\"defaultCurrency\\\": \\\"USD\\\",\\n    \\\"status\\\": \\\"PENDING\\\",\\n    \\\"statusMessage\\\": null,\\n    \\\"waitingPrompts\\\": [],\\n    \\\"linkType\\\": \\\"LOCAL_TRANSFER\\\",\\n    \\\"beneficiaryType\\\": \\\"UNKNOWN\\\",\\n    \\\"supportsDeposit\\\": true,\\n    \\\"nameOnMethod\\\": null,\\n    \\\"last4Digits\\\": \\\"0000\\\",\\n    \\\"brand\\\": null,\\n    \\\"expirationDisplay\\\": null,\\n    \\\"countryCode\\\": \\\"US\\\",\\n    \\\"nickname\\\": null,\\n    \\\"rejectionMessage\\\": null,\\n    \\\"disabled\\\": false,\\n    \\\"supportsPayment\\\": true,\\n    \\\"chargeableCurrencies\\\": [\\n        \\\"USD\\\"\\n    ],\\n    \\\"depositableCurrencies\\\": [\\n        \\\"USD\\\"\\n    ],\\n    \\\"chargeFeeSchedule\\\": null,\\n    \\\"depositFeeSchedule\\\": null,\\n    \\\"minCharge\\\": null,\\n    \\\"maxCharge\\\": null,\\n    \\\"minDeposit\\\": null,\\n    \\\"maxDeposit\\\": null,\\n    \\\"documents\\\": [],\\n    \\\"srn\\\": \\\"paymentmethod:PA-W7YN28ABCHT\\\",\\n  \\t\\\"blockchains\\\": {\\n      \\\"BTC\\\": \\\"1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2\\\",\\n      \\\"ETH\\\": \\\"0x32Be343B94f860124dC4fEe278FDCBD38C102D88\\\"\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Payment Method Statuses\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"PENDING\",\n    \"3-0\": \"REJECTED\",\n    \"1-0\": \"AWAITING_FOLLOWUP\",\n    \"2-0\": \"ACTIVE\",\n    \"0-1\": \"Payment Method has not been activated and is PENDING review on Wyre's side. No user action is required.\",\n    \"1-1\": \"Payment Method requires additional information from the user before being useful. The case where you would see this is on [WIRE_TRANSFER](doc:create-payment-method) payment methods when the bank statement is still required.\",\n    \"2-1\": \"Payment Method is active and ready for use.\",\n    \"3-1\": \"Payment Method has been rejected by Wyre and cannot be used.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Payment Method Types\"\n}\n[/block]\nFor some more information on the differences between different types of Payment Methods check out [Payment Method Types](doc:payment-method-types)\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"LinkType value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"WIRE_TRANSFER\",\n    \"0-1\": \"INTERNATIONAL_TRANSFER\",\n    \"0-2\": \"Wire transfer\",\n    \"1-0\": \"LOCAL_TRANSFER\",\n    \"1-1\": \"LOCAL_TRANSFER\",\n    \"1-2\": \"Transfer using the local banking system. In the case of US, this would be an ACH payment.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Blockchain Attachment & Liquidation\"\n}\n[/block]\nPayment methods may be connected to any of blockchains we support. This means that any transactions in supported currencies sent to that address will have their totals converted and liquidated to the payment method.\n\nYou may attach blockchain when creating payment methods by supplying a request parameter `attachBlockchains` as an array of currencies, or `ALL` for all presently available.\n\nYou may also attach the blockchains to existing payment methods with [this endpoint](doc:attach-blockchain-to-payment-method).\n[block:api-header]\n{\n  \"title\": \"Lifecycle and Exceptions\"\n}\n[/block]\nThere are four edge cases that would trigger a user into a `non approved` state after submitting KYC information and connecting a bank account.\n\n1. A user needs to re-submit a piece of initial account information.\n2. User needs to re-submit an ID image\n3. A user needs to submit a Proof of Address\n4. A user needs to submit an ACH authorization form.\n[block:api-header]\n{\n  \"title\": \"1. A user needs to re-submit a piece of initial account information.\"\n}\n[/block]\nThis typically happens when a user submit KYC information during the account creation stage and his/her information doesn't match up with the ID that was submitted, incorrect/invalid info provided, such as incorrect DOB, invalid address, misspelled legal name, or SSN/ITIN is needed. An email will be send to the user, and then the user can log into the [dashboard](https://dash.sendwyre.com/sign-in) and submit the correct information.\n\nOn the API level, after a user submits data, the status of each  `fieldId` in the response object from the [get_account](https://docs.sendwyre.com/docs/get-account) endpoint returns back a `PENDING` status for whichever `fieldId` that corresponds to the incorrectly input KYC data point. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\" : \\\"AC-U4BWHGZDG6W\\\",\\n\\t...,\\n\\t\\\"profileFields\\\" : [ {\\n    \\\"fieldId\\\" : \\\"individualSsn\\\",\\n    \\\"fieldType\\\" : \\\"STRING\\\",\\n    \\\"value\\\" : null,\\n    \\\"note\\\" : \\\"Please provide a valid social security number.\\\",\\n    \\\"status\\\" : \\\"OPEN\\\"\\n  }, {\\n  ...\\n  }]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nThere could be different `note`s for different user actions based on each KYC data point. \n[block:api-header]\n{\n  \"title\": \"2. User needs to re-submit an ID image\"\n}\n[/block]\nThis typically happens when a user submits an ID that:\n\n- isn't legible, blurry image\n- pictures doesn't encapsulate the entire image, all four corners are not showing\n- Image doesn't match with the correct initial account KYC data\n\nThe user will then get an email to upload a new image to the dashboard.\n\nOn the API level, the key/value `\"fieldId\":\"individualGovernmentId\"` will go from `PENDING` after an image is submitted, back to `OPEN` if the image is rejected.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\" : \\\"AC-U4BWHGZDG6W\\\",\\n\\t...,\\n\\t\\\"profileFields\\\" : [ {\\n    \\\"fieldId\\\" : \\\"individualGovernmentId\\\",\\n    \\\"fieldType\\\" : \\\"DOCUMENT\\\",\\n    \\\"value\\\" : [\\\"DO_B9QJCMN2QBB\\\"],\\n    \\\"note\\\" : \\\"Document is expired\\\",\\n    \\\"status\\\" : \\\"OPEN\\\"\\n  }, {\\n  ...\\n  }]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nIt's important to look at the `note` section of the server response object. The note will give context as to why an image will not work. Other notes include:\n\n- Identification needs to be in full color\n- Identification is blurry/hard to read\n- Document must include all four corners\n- Please submit a passport, driver's license or govt. issued identification document\n- Identification document is not supported\n[block:api-header]\n{\n  \"title\": \"3. A user needs to submit a Proof of Address\"\n}\n[/block]\nThis typically happens when a user submits an ID and inputs KYC address data that doesn't match. A proof of address document such as a:\n\n- Utility Bill\n- Bank Statement\n\nOn the API level, the key/value `\"fieldId\":\"individualGovernmentId\"` will go from `PENDING` after an image is submitted, back to `OPEN` if the image is rejected.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"id\\\" : \\\"AC-U4BWHGZDG6W\\\",\\n\\t...,\\n\\t\\\"profileFields\\\" : [{\\n   \\\"fieldId\\\": \\\"individualGovernmentId\\\"\\n    \\\"fieldType\\\": \\\"DOCUMENT\\\",\\n    \\\"value\\\": [DO_B9QJCMN2QB9],\\n    \\\"note\\\": \\\"Document must include all four corners\\\",\\n    \\\"status\\\": \\\"OPEN\\\"\\n \\t}, {\\n  ...\\n  }]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nIt's important to look at the `note` section of the server response object. The note will give context as to why an image will not work. Other notes include:\n\n- Please provide a translated copy of this document\n- Utility Bill does not match profile address\n- Bank Statement does not match profile address\n- Please provide utility bill that matches profile address\n- Please provide all pages of Bank statement for verification\n[block:api-header]\n{\n  \"title\": \"4. A user needs to submit an ACH authorization form.\"\n}\n[/block]\nThis typically happens when a user submits an ID, inputs KYC data, uploads a bank account payment method and data doesn't match. Examples include:\n\n1. Does not match the registered legal name\n2. Does not match the registered email\n3. Does not match the registered phone number\n4. Does not match the registered address nor have a valid proof of address on file\n5. Does not have transaction posted in transaction history\n6. Does not have a sufficient balance to cover the transaction\n\n\n **Submitting documentation via support.sendwyre.com**\n\nThis will trigger the event of sending an email out to a users. \nAfter clicking the link in the email, users will be taken to support.sendwyre.com and will immediately be shown the following prompt.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/1ba0945-Screen_Shot_2019-05-09_at_11.43.29_AM.png\",\n        \"Screen Shot 2019-05-09 at 11.43.29 AM.png\",\n        429,\n        250,\n        \"#2e2e2f\"\n      ]\n    }\n  ]\n}\n[/block]\nYou'll then need to upload a picture of your face next to a piece of paper with the following written down:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/08c2bb3-ACHATuh.png\",\n        \"ACHATuh.png\",\n        2545,\n        1744,\n        \"#9dcbe3\"\n      ]\n    }\n  ]\n}\n[/block]\nOnce submitted, our team will review and process the information.\n\n**Submitting documentation via the WYRE API**\n\nIf an account goes into a status that needs an authorization form, Partners have an option of sending the authorization form via the endpoint below. \n\nhttps://api.sendwyre.com/v2/paymentMethod/:paymentMethodId/followup\n\nThe response to the account and paymentMethod endpoints will update accordingly during the following states when collecting the ACH form. The account endpoint response will only update if the payment method is the individual source of funds.\n\nWhen an ACH form has been initially been requested:\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"//GET /accounts/:accountId\\n\\n[\\n\\t...\\n  {\\n  \\tfieldId: \\\"individualSourceOfFunds\\\",\\n    fieldType: \\\"PAYMENT_METHOD\\\",\\n    value: \\\"PM_XXXXX\\\",\\n    note: \\\"Additional information is required.\\\",\\n    status: \\\"OPEN\\\"\\n  }\\n]\\n\\n// GET /paymethMethod/PM_XXXXX\\n\\n{\\n    ...\\n    status: \\\"AWAITING_FOLLOWUP\\\",\\n    waitingPrompts: [{\\n    \\tid: \\\"ACH_FORM\\\"\\n      prompt: \\\"Please upload a picture of yourself with the following written down on a piece of paper next to your face: `Wyre`, today's date, the last 4 digits of your bank account number and your signature.\\\",\\n  \\t\\ttype: \\\"DOCUMENT\\\"\\n\\t\\t}]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nWhen an ACH form has been submitted through the upload document for payment method endpoint and is in review:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" \\n//GET /accounts/:accountId\\n​\\n[\\n  ...\\n  {\\n    fieldId: \\\"individualSourceOfFunds\\\",\\n    fieldType: \\\"PAYMENT_METHOD\\\",\\n    value: \\\"PM_XXXXX\\\",\\n    note: \\\"Payment method is under review.\\\",\\n    status: \\\"PENDING\\\"\\n  }\\n]\\n​\\n// GET /paymethMethod/PM_XXXXX\\n{\\n    ...\\n    status: \\\"AWAITING_FOLLOWUP\\\",\\n    waitingPrompts: []\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nWhen an ACH form has been submitted through the upload documents for payment method endpoint and has been approved:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"//GET /accounts/:accountId\\n\\n[\\n\\t...\\n  {\\n  \\tfieldId: \\\"individualSourceOfFunds\\\",\\n    fieldType: \\\"PAYMENT_METHOD\\\",\\n    value: \\\"PM_XXXXX\\\",\\n    note: null,\\n    status: \\\"APPROVED\\\"\\n  }\\n]\\n\\n// GET /paymethMethod/PM_XXXXX\\n{\\n    ...\\n    status: \\\"APPROVED\\\",\\n    waitingPrompts: []\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Outline of different payment types you can do from Wyre","slug":"payment-method-overview","type":"basic","title":"Payment Method Overview"}

Payment Method Overview

Outline of different payment types you can do from Wyre

[block:callout] { "type": "warning", "title": "Payment Method APIs still on v2", "body": "Please note that we are currently working on upgrading out Payment Method APIs. The APIs laid out in this document still have API v2 URLs. Our new APIs will include the functionality outlined here as well as additional functionality." } [/block] Payment Method resources are generic resources that represent a payment method connected to the financial system. A Payment Method, as returned by the Wyre, looks like this: [block:code] { "codes": [ { "code": "{\n \"id\": \"PA-W7YN28ABCHT\",\n \"owner\": \"account:AC-XX38VYXUA84\",\n \"createdAt\": 1542771684392,\n \"name\": \"Plaid Checking 0000\",\n \"defaultCurrency\": \"USD\",\n \"status\": \"PENDING\",\n \"statusMessage\": null,\n \"waitingPrompts\": [],\n \"linkType\": \"LOCAL_TRANSFER\",\n \"beneficiaryType\": \"UNKNOWN\",\n \"supportsDeposit\": true,\n \"nameOnMethod\": null,\n \"last4Digits\": \"0000\",\n \"brand\": null,\n \"expirationDisplay\": null,\n \"countryCode\": \"US\",\n \"nickname\": null,\n \"rejectionMessage\": null,\n \"disabled\": false,\n \"supportsPayment\": true,\n \"chargeableCurrencies\": [\n \"USD\"\n ],\n \"depositableCurrencies\": [\n \"USD\"\n ],\n \"chargeFeeSchedule\": null,\n \"depositFeeSchedule\": null,\n \"minCharge\": null,\n \"maxCharge\": null,\n \"minDeposit\": null,\n \"maxDeposit\": null,\n \"documents\": [],\n \"srn\": \"paymentmethod:PA-W7YN28ABCHT\",\n \t\"blockchains\": {\n \"BTC\": \"1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2\",\n \"ETH\": \"0x32Be343B94f860124dC4fEe278FDCBD38C102D88\"\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Payment Method Statuses" } [/block] [block:parameters] { "data": { "h-0": "Status", "h-1": "Description", "0-0": "PENDING", "3-0": "REJECTED", "1-0": "AWAITING_FOLLOWUP", "2-0": "ACTIVE", "0-1": "Payment Method has not been activated and is PENDING review on Wyre's side. No user action is required.", "1-1": "Payment Method requires additional information from the user before being useful. The case where you would see this is on [WIRE_TRANSFER](doc:create-payment-method) payment methods when the bank statement is still required.", "2-1": "Payment Method is active and ready for use.", "3-1": "Payment Method has been rejected by Wyre and cannot be used." }, "cols": 2, "rows": 4 } [/block] [block:api-header] { "title": "Payment Method Types" } [/block] For some more information on the differences between different types of Payment Methods check out [Payment Method Types](doc:payment-method-types) [block:parameters] { "data": { "h-0": "Type", "h-1": "LinkType value", "h-2": "Description", "0-0": "WIRE_TRANSFER", "0-1": "INTERNATIONAL_TRANSFER", "0-2": "Wire transfer", "1-0": "LOCAL_TRANSFER", "1-1": "LOCAL_TRANSFER", "1-2": "Transfer using the local banking system. In the case of US, this would be an ACH payment." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "title": "Blockchain Attachment & Liquidation" } [/block] Payment methods may be connected to any of blockchains we support. This means that any transactions in supported currencies sent to that address will have their totals converted and liquidated to the payment method. You may attach blockchain when creating payment methods by supplying a request parameter `attachBlockchains` as an array of currencies, or `ALL` for all presently available. You may also attach the blockchains to existing payment methods with [this endpoint](doc:attach-blockchain-to-payment-method). [block:api-header] { "title": "Lifecycle and Exceptions" } [/block] There are four edge cases that would trigger a user into a `non approved` state after submitting KYC information and connecting a bank account. 1. A user needs to re-submit a piece of initial account information. 2. User needs to re-submit an ID image 3. A user needs to submit a Proof of Address 4. A user needs to submit an ACH authorization form. [block:api-header] { "title": "1. A user needs to re-submit a piece of initial account information." } [/block] This typically happens when a user submit KYC information during the account creation stage and his/her information doesn't match up with the ID that was submitted, incorrect/invalid info provided, such as incorrect DOB, invalid address, misspelled legal name, or SSN/ITIN is needed. An email will be send to the user, and then the user can log into the [dashboard](https://dash.sendwyre.com/sign-in) and submit the correct information. On the API level, after a user submits data, the status of each `fieldId` in the response object from the [get_account](https://docs.sendwyre.com/docs/get-account) endpoint returns back a `PENDING` status for whichever `fieldId` that corresponds to the incorrectly input KYC data point. [block:code] { "codes": [ { "code": "{\n \"id\" : \"AC-U4BWHGZDG6W\",\n\t...,\n\t\"profileFields\" : [ {\n \"fieldId\" : \"individualSsn\",\n \"fieldType\" : \"STRING\",\n \"value\" : null,\n \"note\" : \"Please provide a valid social security number.\",\n \"status\" : \"OPEN\"\n }, {\n ...\n }]\n}", "language": "json" } ] } [/block] There could be different `note`s for different user actions based on each KYC data point. [block:api-header] { "title": "2. User needs to re-submit an ID image" } [/block] This typically happens when a user submits an ID that: - isn't legible, blurry image - pictures doesn't encapsulate the entire image, all four corners are not showing - Image doesn't match with the correct initial account KYC data The user will then get an email to upload a new image to the dashboard. On the API level, the key/value `"fieldId":"individualGovernmentId"` will go from `PENDING` after an image is submitted, back to `OPEN` if the image is rejected. [block:code] { "codes": [ { "code": "{\n \"id\" : \"AC-U4BWHGZDG6W\",\n\t...,\n\t\"profileFields\" : [ {\n \"fieldId\" : \"individualGovernmentId\",\n \"fieldType\" : \"DOCUMENT\",\n \"value\" : [\"DO_B9QJCMN2QBB\"],\n \"note\" : \"Document is expired\",\n \"status\" : \"OPEN\"\n }, {\n ...\n }]\n}", "language": "json" } ] } [/block] It's important to look at the `note` section of the server response object. The note will give context as to why an image will not work. Other notes include: - Identification needs to be in full color - Identification is blurry/hard to read - Document must include all four corners - Please submit a passport, driver's license or govt. issued identification document - Identification document is not supported [block:api-header] { "title": "3. A user needs to submit a Proof of Address" } [/block] This typically happens when a user submits an ID and inputs KYC address data that doesn't match. A proof of address document such as a: - Utility Bill - Bank Statement On the API level, the key/value `"fieldId":"individualGovernmentId"` will go from `PENDING` after an image is submitted, back to `OPEN` if the image is rejected. [block:code] { "codes": [ { "code": "{\n \"id\" : \"AC-U4BWHGZDG6W\",\n\t...,\n\t\"profileFields\" : [{\n \"fieldId\": \"individualGovernmentId\"\n \"fieldType\": \"DOCUMENT\",\n \"value\": [DO_B9QJCMN2QB9],\n \"note\": \"Document must include all four corners\",\n \"status\": \"OPEN\"\n \t}, {\n ...\n }]\n}", "language": "json" } ] } [/block] It's important to look at the `note` section of the server response object. The note will give context as to why an image will not work. Other notes include: - Please provide a translated copy of this document - Utility Bill does not match profile address - Bank Statement does not match profile address - Please provide utility bill that matches profile address - Please provide all pages of Bank statement for verification [block:api-header] { "title": "4. A user needs to submit an ACH authorization form." } [/block] This typically happens when a user submits an ID, inputs KYC data, uploads a bank account payment method and data doesn't match. Examples include: 1. Does not match the registered legal name 2. Does not match the registered email 3. Does not match the registered phone number 4. Does not match the registered address nor have a valid proof of address on file 5. Does not have transaction posted in transaction history 6. Does not have a sufficient balance to cover the transaction **Submitting documentation via support.sendwyre.com** This will trigger the event of sending an email out to a users. After clicking the link in the email, users will be taken to support.sendwyre.com and will immediately be shown the following prompt. [block:image] { "images": [ { "image": [ "https://files.readme.io/1ba0945-Screen_Shot_2019-05-09_at_11.43.29_AM.png", "Screen Shot 2019-05-09 at 11.43.29 AM.png", 429, 250, "#2e2e2f" ] } ] } [/block] You'll then need to upload a picture of your face next to a piece of paper with the following written down: [block:image] { "images": [ { "image": [ "https://files.readme.io/08c2bb3-ACHATuh.png", "ACHATuh.png", 2545, 1744, "#9dcbe3" ] } ] } [/block] Once submitted, our team will review and process the information. **Submitting documentation via the WYRE API** If an account goes into a status that needs an authorization form, Partners have an option of sending the authorization form via the endpoint below. https://api.sendwyre.com/v2/paymentMethod/:paymentMethodId/followup The response to the account and paymentMethod endpoints will update accordingly during the following states when collecting the ACH form. The account endpoint response will only update if the payment method is the individual source of funds. When an ACH form has been initially been requested: [block:code] { "codes": [ { "code": "//GET /accounts/:accountId\n\n[\n\t...\n {\n \tfieldId: \"individualSourceOfFunds\",\n fieldType: \"PAYMENT_METHOD\",\n value: \"PM_XXXXX\",\n note: \"Additional information is required.\",\n status: \"OPEN\"\n }\n]\n\n// GET /paymethMethod/PM_XXXXX\n\n{\n ...\n status: \"AWAITING_FOLLOWUP\",\n waitingPrompts: [{\n \tid: \"ACH_FORM\"\n prompt: \"Please upload a picture of yourself with the following written down on a piece of paper next to your face: `Wyre`, today's date, the last 4 digits of your bank account number and your signature.\",\n \t\ttype: \"DOCUMENT\"\n\t\t}]\n}", "language": "json" } ] } [/block] When an ACH form has been submitted through the upload document for payment method endpoint and is in review: [block:code] { "codes": [ { "code": " \n//GET /accounts/:accountId\n​\n[\n ...\n {\n fieldId: \"individualSourceOfFunds\",\n fieldType: \"PAYMENT_METHOD\",\n value: \"PM_XXXXX\",\n note: \"Payment method is under review.\",\n status: \"PENDING\"\n }\n]\n​\n// GET /paymethMethod/PM_XXXXX\n{\n ...\n status: \"AWAITING_FOLLOWUP\",\n waitingPrompts: []\n}", "language": "json" } ] } [/block] When an ACH form has been submitted through the upload documents for payment method endpoint and has been approved: [block:code] { "codes": [ { "code": "//GET /accounts/:accountId\n\n[\n\t...\n {\n \tfieldId: \"individualSourceOfFunds\",\n fieldType: \"PAYMENT_METHOD\",\n value: \"PM_XXXXX\",\n note: null,\n status: \"APPROVED\"\n }\n]\n\n// GET /paymethMethod/PM_XXXXX\n{\n ...\n status: \"APPROVED\",\n waitingPrompts: []\n}", "language": "json" } ] } [/block]