{"_id":"5bc6340a59b7830013d8f069","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":"54eb883f4f94620d00789aaa","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":["5d7288ec5e2f260262061714"],"next":{"pages":[],"description":""},"createdAt":"2018-10-16T18:55:06.391Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","apiSetting":null,"auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Documentation is a Work in Progress\",\n  \"body\": \"Welcome to the Wyre API v3 documentation! This documentation is a work in progress, as we finalize functionality we will be adding it to the docs. Anything that has already been documented is fully functional and we are not planning on making changes.\\n\\nSome pages may appear blank or light on details until we complete the functionality.\"\n}\n[/block]\n\n# Overview\n\nWyre offers a powerful JSON REST API that supporting a range of financial, cryptocurrency, and identity services. It can move money around, broker exchanges, validate KYC/AML information, and transfer to/from traditional banking systems all while remaining compliant. We offer four sets of distinct API functionality:\n\n- **Accounts**: manage balances and KYC data of individuals\n- **Transfers**: moving and exchanging funds\n- **Payment Methods**: linking external accounts for access to funds - banks, cards, etc\n- **Rates**: get up-to-date exchange rates\n\nTo foster a better development experience for our partners, we offer a [test environment](doc:productiontest-environments) in addition to production. Any transfers made in the test environment will never hit the actual blockchain network or incur any fees.\n\nThe V2 API documentation can be found [here](https://www.sendwyre.com/legacy-docs).\n\n# Getting Started\n\n**How to get Started**\n\n**Step 1. Read the documentation**\nWe recommend that you read the API documentation and familiarize yourself with the different API functions and calls so you can get the most out of the Wyre API!\n\n**Step 2. Contact our sales team**\nEmail our team at [sales:::at:::sendwyre.com](sales@sendwyre.com) so we can verify if our solution will satisfy your business needs.\n\n**Step 3. Connect with engineering support**\nWyre will provide you with a dedicated support channel to address your questions as you integrate.\n\n**Step 4. Register a production account**\nOnce testing has completed, you can register a live account [here](https://sendwyre.com). You must go through the entire on-boarding and verification process before you are allowed to send funds.\n\n**Step 5. Go live!**\n\n# JSON Interface\n\nThe Wyre API uses JSON objects within a REST-like URI and method structure. The HTTP methods `GET`, `POST`, and `DELETE` are used for querying, sending, and deleting, respectively.\n\nSuccessful API responses will have a status of `200` if there is a payload, or `204` if there is not.  Any status code 300 or greater indicates a problem occurred - see [Errors](doc:errors) for more information.\n\nThe following table defines the status codes you may receive from our API:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"HTTP Status Code\",\n    \"h-1\": \"Meaning\",\n    \"0-0\": \"200\",\n    \"1-0\": \"204\",\n    \"1-1\": \"Successful, no response data\",\n    \"0-1\": \"Successful, with response data as defined by the `Content-Type` header. Usually JSON\",\n    \"2-0\": \"401\",\n    \"2-1\": \"Failure. Access denied\",\n    \"3-0\": \"400\",\n    \"3-1\": \"Failure. There was a problem with your request\",\n    \"4-0\": \"500\",\n    \"4-1\": \"Failure. There was an unexpected problem with our system\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]\nDuring troubleshooting, please note that if your error response does not follow the previously mentioned format, the error is most likely due to a different endpoint.\n\n# Webhooks / Callbacks\n\nAs an alternative to polling, you may wish to receive realtime notifications when certain objects change. These can be created automatically when transfers are initiated, as well as directly for other kinds of objects by using the [Subscribe Webhook](doc:subscribe-webhook) endpoint.","excerpt":"","slug":"general","type":"basic","title":"General"}

Wyre API

Widget

Key Management

Accounts

Payment Methods

Transfers & Exchanges

Data Subscriptions

General

[block:callout] { "type": "info", "title": "Documentation is a Work in Progress", "body": "Welcome to the Wyre API v3 documentation! This documentation is a work in progress, as we finalize functionality we will be adding it to the docs. Anything that has already been documented is fully functional and we are not planning on making changes.\n\nSome pages may appear blank or light on details until we complete the functionality." } [/block] # Overview Wyre offers a powerful JSON REST API that supporting a range of financial, cryptocurrency, and identity services. It can move money around, broker exchanges, validate KYC/AML information, and transfer to/from traditional banking systems all while remaining compliant. We offer four sets of distinct API functionality: - **Accounts**: manage balances and KYC data of individuals - **Transfers**: moving and exchanging funds - **Payment Methods**: linking external accounts for access to funds - banks, cards, etc - **Rates**: get up-to-date exchange rates To foster a better development experience for our partners, we offer a [test environment](doc:productiontest-environments) in addition to production. Any transfers made in the test environment will never hit the actual blockchain network or incur any fees. The V2 API documentation can be found [here](https://www.sendwyre.com/legacy-docs). # Getting Started **How to get Started** **Step 1. Read the documentation** We recommend that you read the API documentation and familiarize yourself with the different API functions and calls so you can get the most out of the Wyre API! **Step 2. Contact our sales team** Email our team at [sales@sendwyre.com](sales@sendwyre.com) so we can verify if our solution will satisfy your business needs. **Step 3. Connect with engineering support** Wyre will provide you with a dedicated support channel to address your questions as you integrate. **Step 4. Register a production account** Once testing has completed, you can register a live account [here](https://sendwyre.com). You must go through the entire on-boarding and verification process before you are allowed to send funds. **Step 5. Go live!** # JSON Interface The Wyre API uses JSON objects within a REST-like URI and method structure. The HTTP methods `GET`, `POST`, and `DELETE` are used for querying, sending, and deleting, respectively. Successful API responses will have a status of `200` if there is a payload, or `204` if there is not. Any status code 300 or greater indicates a problem occurred - see [Errors](doc:errors) for more information. The following table defines the status codes you may receive from our API: [block:parameters] { "data": { "h-0": "HTTP Status Code", "h-1": "Meaning", "0-0": "200", "1-0": "204", "1-1": "Successful, no response data", "0-1": "Successful, with response data as defined by the `Content-Type` header. Usually JSON", "2-0": "401", "2-1": "Failure. Access denied", "3-0": "400", "3-1": "Failure. There was a problem with your request", "4-0": "500", "4-1": "Failure. There was an unexpected problem with our system" }, "cols": 2, "rows": 5 } [/block] During troubleshooting, please note that if your error response does not follow the previously mentioned format, the error is most likely due to a different endpoint. # Webhooks / Callbacks As an alternative to polling, you may wish to receive realtime notifications when certain objects change. These can be created automatically when transfers are initiated, as well as directly for other kinds of objects by using the [Subscribe Webhook](doc:subscribe-webhook) endpoint.