{"_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":1,"parentDoc":null,"updates":["5c6c8a83a74d56001373b552"],"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).","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).