{"_id":"5c12b8aeab9f6101893e0c0d","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":"550f75de61d9d30d00af9e02","version":"550f75de61d9d30d00af9e01","__v":5,"pages":["550f75df61d9d30d00af9e03","551025e12dd9010d0019e0e0","551027d90f12ba0d00b2e187","551050c98579861900a86718","55a6befa8cc73e0d0009656c"],"project":"550f74bb6fc8130d0038aad3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-23T02:04:44.057Z","from_sync":false,"order":2,"slug":"documentation","title":"Wyre API"},"user":"54eb8076867e1917009b7160","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-13T19:53:18.451Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","apiSetting":null,"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"# Overview\n\nWyre offers a powerful REST API that supports wire transfers, mass international payouts, cryptocurrency wallet management, and virtual banking services for your personal or enterprise needs.\n\nOur API uses HTTPS response codes and returns all error responses in JSON. To explore the API as much as possible, we offer a test environment in addition to production. Any transfers made in the test environment will never hit the actual blockchain network or incur any fees. Both sandbox and production rely on API keys for authentication.\n\nThe legacy API documentation can be found [here](https://docs.sendwyre.com/docs/overview).\n\n# Getting Started\n\nThe Wyre API is designed for enterprises who need to send cross-border payments for end-to-end delivery in a matter of hours. Wyre transfers value instantly, achieves FX conversions equal to or better than midmarket, and utilizes local banking networks to complete bank-to-bank transfers.\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. Assign a dedicated support engineer**\nWyre will assign a support engineer to your integration at no additional cost to assist you with any integration related questions during your testing.\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. Prefund your production account**\nTo learn more about topping up your account, please refer to more information [here](https://support.sendwyre.com/getting-started/get-started-on-the-right-foot/video-adding-funds-to-your-account).\n\n**Step 6. Start sending funds**\nYou are ready to send your first live payment!\n\n# Supported Currencies\n\nWe support a number of fiat currencies and cryptocurrencies including BTC, DAI, ETH, WEth, and ERC20 tokens. Please refer to the [Live Exchange Rates](doc:live-exchange-rates) API for more info on exchange rates between crypto and fiat.\n\n️Please note that we are not able to support any crypto pairs for Chinese based (including HK) clients due to government regulations.\n\nLearn more about our supported currency pairs [here](https://support.sendwyre.com/sending-money/supported-currencies)\n\n\n# Transport Method\n\nFor successful API calls:\n```json\n{\n        \"parameter\": \"en\",\n        \"parameter\": \"ABCDEF\"\n}\n```\n\nFor unsuccessful API calls:\n\n```json\n{\n        \"language\":\"en\",\n        \"exceptionId\":\"ABCDEF\"\n        \"compositeType\":\"\",\n        \"subType\":\"\",\n        \"message\":\"Error Message\",\n        \"type\":\"ErrorTypeException\",\n        \"transient\":false\n}\n```\n\nWyre provides a REST API that will always return a JSON Object as the response.\n\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# Production/Test Endpoints\n\nWe have two environments: a test environment for API integration testing, and our live production. The test environment uses the same live exchange rates as our production environment.\n\nEnvironment | Endpoint | Dashboard\n----------- | -------- | ----------\nTest | [https://api.testwyre.com](https://api.testwyre.com/v2/status) | [https://www.testwyre.com](https://www.testwyre.com) \nProduction | [https://api.sendwyre.com](https://api.sendwyre.com/v2/status) | [https://dash.sendwyre.com](https://dash.sendwyre.com) \n\n**Bitcoin Test Environment**\nPlease note that our test environment is live on TestNet3 for BTC.  For BTC TestNet funds, please refer [here](https://testnet.manu.backend.hamburg/faucet). You will expect to receive 1 confirmation on the network.\n\n**Ethereum Test Environment**\nThe test environment for ETH is Kovan. For ETH TestNet funds, please refer [here](https://github.com/kovan-testnet/faucet). The Ethereum Block Explorer is also [here](https://kovan.etherscan.io/). Funds will be deposited in your account **10 confirmations** on the network.\n\n# Pagination\n\nWe split our tabular data into pages of 25 items. You can apply the parameters below to any request for tabular to adjust the pagination.\n\nParameter | Description\n--------- | -----------\noffset | How many items are skipped before the first item that is shown (default: 0).\nlimit | Number of items returned per page (default: 25).\nfrom | The lower bound of a creation time filter for the displayed items. Formatted in millisecond Epoch format. (default: 0)\nto | The upper bound of a creation time filter for the displayed items. Formatted in millisecond Epoch format. (default: current time)","excerpt":"","slug":"overview","type":"basic","title":"Overview"}
# Overview Wyre offers a powerful REST API that supports wire transfers, mass international payouts, cryptocurrency wallet management, and virtual banking services for your personal or enterprise needs. Our API uses HTTPS response codes and returns all error responses in JSON. To explore the API as much as possible, we offer a test environment in addition to production. Any transfers made in the test environment will never hit the actual blockchain network or incur any fees. Both sandbox and production rely on API keys for authentication. The legacy API documentation can be found [here](https://docs.sendwyre.com/docs/overview). # Getting Started The Wyre API is designed for enterprises who need to send cross-border payments for end-to-end delivery in a matter of hours. Wyre transfers value instantly, achieves FX conversions equal to or better than midmarket, and utilizes local banking networks to complete bank-to-bank transfers. **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. Assign a dedicated support engineer** Wyre will assign a support engineer to your integration at no additional cost to assist you with any integration related questions during your testing. **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. Prefund your production account** To learn more about topping up your account, please refer to more information [here](https://support.sendwyre.com/getting-started/get-started-on-the-right-foot/video-adding-funds-to-your-account). **Step 6. Start sending funds** You are ready to send your first live payment! # Supported Currencies We support a number of fiat currencies and cryptocurrencies including BTC, DAI, ETH, WEth, and ERC20 tokens. Please refer to the [Live Exchange Rates](doc:live-exchange-rates) API for more info on exchange rates between crypto and fiat. ️Please note that we are not able to support any crypto pairs for Chinese based (including HK) clients due to government regulations. Learn more about our supported currency pairs [here](https://support.sendwyre.com/sending-money/supported-currencies) # Transport Method For successful API calls: ```json { "parameter": "en", "parameter": "ABCDEF" } ``` For unsuccessful API calls: ```json { "language":"en", "exceptionId":"ABCDEF" "compositeType":"", "subType":"", "message":"Error Message", "type":"ErrorTypeException", "transient":false } ``` Wyre provides a REST API that will always return a JSON Object as the response. 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. # Production/Test Endpoints We have two environments: a test environment for API integration testing, and our live production. The test environment uses the same live exchange rates as our production environment. Environment | Endpoint | Dashboard ----------- | -------- | ---------- Test | [https://api.testwyre.com](https://api.testwyre.com/v2/status) | [https://www.testwyre.com](https://www.testwyre.com) Production | [https://api.sendwyre.com](https://api.sendwyre.com/v2/status) | [https://dash.sendwyre.com](https://dash.sendwyre.com) **Bitcoin Test Environment** Please note that our test environment is live on TestNet3 for BTC. For BTC TestNet funds, please refer [here](https://testnet.manu.backend.hamburg/faucet). You will expect to receive 1 confirmation on the network. **Ethereum Test Environment** The test environment for ETH is Kovan. For ETH TestNet funds, please refer [here](https://github.com/kovan-testnet/faucet). The Ethereum Block Explorer is also [here](https://kovan.etherscan.io/). Funds will be deposited in your account **10 confirmations** on the network. # Pagination We split our tabular data into pages of 25 items. You can apply the parameters below to any request for tabular to adjust the pagination. Parameter | Description --------- | ----------- offset | How many items are skipped before the first item that is shown (default: 0). limit | Number of items returned per page (default: 25). from | The lower bound of a creation time filter for the displayed items. Formatted in millisecond Epoch format. (default: 0) to | The upper bound of a creation time filter for the displayed items. Formatted in millisecond Epoch format. (default: current time)