{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v2/wallets","auth":"required","settings":"","results":{"codes":[{"name":"","code":"{\n      \"owner\": \"account:AC_XXXXXXXXXX\",\n      \"pendingInterestBalances\": {\n          \"ETH\": 0E-20,\n          \"DAI\": 0E-20,\n          \"USDC\": 0E-20,\n          \"BTC\": 0.00000190099863013697\n      },\n      \"savingRates\": {\n          \"ETH\": 0.04000000000000000000,\n          \"DAI\": 0E-20,\n          \"USDC\": 0.08000000000000000000,\n          \"BTC\": 0.03500000000000000000\n      },\n      \"status\": null,\n      \"balances\": {\n          \"DAI\": 16.83622828784119106700,\n          \"USDC\": 7.08476400000000000000,\n          \"BTC\": 0.00263210000000000000\n      },\n      \"createdAt\": 1609186777000,\n      \"pusherChannel\": \"d89ecb3deae49a753c0df3a2166f46dd\",\n      \"srn\": \"wallet:WA_XXXXXXXXXX\",\n      \"notes\": null,\n      \"depositAddresses\": {\n          \"ETH\": \"0x31e5312ca39cdcc855b8e61a35bf75be00f3cc20\",\n          \"BTC\": \"mxsd7xTcVow7bnxdMhwiyTdWvXKqar1nZG\"\n      },\n      \"totalBalances\": {\n          \"DAI\": 16.83622828784119106700,\n          \"USDC\": 7.08476400000000000000,\n          \"BTC\": 0.00263210000000000000\n      },\n      \"availableBalances\": {\n          \"DAI\": 16.83622828784119106700,\n          \"USDC\": 7.08476400000000000000,\n          \"BTC\": 0.00263210000000000000\n      },\n      \"callbackUrl\": null,\n      \"name\": \"unique-user-wallet-id\",\n      \"id\": \"WA_XXXXXXXXXX\",\n      \"type\": \"SAVINGS\"\n}","language":"json","status":200}]},"params":[{"name":"type","type":"string","default":"","desc":"\"SAVINGS\"","required":true,"in":"body","ref":"","_id":"60108ae82988a7006c491c36"},{"name":"name","type":"string","default":"","desc":"Your unique identifier for the wallet.","required":true,"in":"body","ref":"","_id":"60108ae82988a7006c491c37"},{"name":"callbackURL","type":"string","default":"","desc":"URL to receive update events about this wallet","required":false,"in":"body","ref":"","_id":"60108ae82988a7006c491c38"},{"name":"notes","type":"string","default":"","desc":"Notes about this wallet or user","required":false,"in":"body","ref":"","_id":"60108ae82988a7006c491c39"}],"examples":{"codes":[{"code":"curl -v -XPOST 'https://api.sendwyre.com/v2/wallets' \\\n\t-H \"Content-Type: application/json\" \\\n  -H \"X-Api-Key: {api-key}\" \\\n  -H \"X-Api-Signature: {signature}\" \\\n\t-d '{\n        \"type\":\"SAVINGS\",\n        \"name\":\"your-unique-identifier\",\n        \"callbackURL\":\"https://your.website.io/callback\",\n        \"notes\":\"Notes about the sub account\"\n      }'","language":"curl","name":"curl"},{"code":"const axios = require('axios');\nconst YOUR-WYRE-API-KEY = AK-XXXX-XXXX-XXXX\n\nasync savingsWallet(req, res, next) {\n        try {\n            const timestamp = new Date().getTime();\n            const url = `https://api.sendwyre.com/v2/wallets?timestamp=${timestamp}`;\n            const headers = {};\n            const body = {\n                name: \"UID-FROM-YOUR-APP\", // Any unique user identifier\n                callbackURL: \"\",\n                type: \"SAVINGS\",\n                notes: \"AC-XXXX-XXXX\"\n            };\n\n            const details = JSON.stringify(body);\n\n            headers['Content-Type'] = 'application/json';\n            headers['X-Api-Key'] = YOUR-WYRE-API-KEY;\n            headers['X-Api-Signature'] = signature(url, details);\n\n            const config = {\n                method: \"POST\",\n                url: url,\n                headers: headers,\n                data: details\n            }\n\n            const response = await axios(config);\n            res.send(response.data);\n\n        } catch (error) {\n            next(error)\n        }\n    }","language":"javascript","name":"Node"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"Create Savings Wallet","type":"endpoint","slug":"creating-crypto-savings-accounts","excerpt":"This is your guide to how to create crypto savings accounts.","body":"[block:callout]\n{\n  \"type\": \"success\",\n  \"body\": \"We're slow-releasing saving accounts to a few partners in Q2 2020 with a full public release in Q3 2020. If you're interested, please email, sales:::at:::sendwyre.com.\"\n}\n[/block]\nBelow is a quick high-level overview of how platforms are able to interact with savings accounts. \n\nThis product is still in beta and we're taking feedback:\n\n## 1. Create Wyre Account\n\nCreate an account on Wyre and message [email protected] that you'd like the savings feature activated for your account. You will need to sign a short agreement prior to starting.\n\n## 2.) Creating Crypto Savings Account\n\nCreate a sub-wallet within your account and give it the \"savings\" label. This will be your dedicated savings account. Within this wallet, you'll have dedicated USDC, BTC, DAI, and ETH addresses.\n\n**PLEASE NOTE:** - you're able to send any support ERC-20 currency to your wallet ( USDC, DAI, ETH) and all of their associate rates are listed within the savingRatePercentages. \n\n## 3.) Transferring Balances in and out of Account\n\nThroughout the month, you will send money in and out of your dedicated savings sub-wallet. Funds need to be in the wallet for over 24 hours to start accruing interest. You'll need to use the Transfer API to accomplish this (for balances located within your Wyre Account) OR simply send money to the deposit addresses located within your savings account.\n\nStart here if you're unfamiliar on how you can use transfers to move money around Wyre: https://docs.sendwyre.com/docs/transfer-resources\n\n## 4.) Receiving Interest and Reviewing Account Balance\n\nYou're able to review your \"pendingInterestBalances\" (the interest balance that has accumulated since the last interest payment). Interest payments will be paid out monthly in the deposited source cryptocurrency.\n\nTo review balances, you'll need to use 1 field:\n- `walletId` - The identifier for the wallet\n\nReach out to us if you have any more questions.","updates":["600b1e2929126a001274c932"],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e812817bdf5b201f222e3e4","createdAt":"2020-03-29T22:58:31.295Z","user":"54ea9905a6f14f0d003e96e7","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Savings (beta)","slug":"savings-beta","order":6,"from_sync":false,"reference":false,"_id":"5e8127d61c906800374eeb1c","createdAt":"2020-03-29T22:57:26.124Z","version":"550f75de61d9d30d00af9e01","project":"550f74bb6fc8130d0038aad3","__v":0},"version":{"version":"3","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["550f75de61d9d30d00af9e02","551027e38579861900a86698","551029e08579861900a8669a","551029e7498062190006328a","5bc633a722d682005c9ad9e4","5bc633b08c4b0b000d6a7eaa","5bc633b48f3ff600626e3e18","5bc63538e5a6ba000d22ee6d","5bc63587a18a6b000decd295","5bc635c0937fcb0056223d9c","5bc6360f42f41800319aeaa6","5be5d13ff1d319002baca9ce","5be5d2287cd14d00291fbfdb","5be8b3b09f7cb70023c56a39","5be8b3cbb910100044e20206","5c1d769a4f6aed001fe527f0","5c402942010f0d001496dded","5e8127d61c906800374eeb1c","5f2768c98622b8005106544a","5f2768d05702ca0011f7655e","5f276e5348d2b600321aef9b","5f276fd300e519001139200a","5f9a2cb79dafe500259281a7","5fd92bf362bb7301b00e48ba"],"_id":"550f75de61d9d30d00af9e01","__v":24,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":3,"parentDoc":null}

postCreate Savings Wallet

This is your guide to how to create crypto savings accounts.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

type:
required
string
"SAVINGS"
name:
required
string
Your unique identifier for the wallet.
callbackURL:
string
URL to receive update events about this wallet
notes:
string
Notes about this wallet or user

Examples


Result Format


Documentation

[block:callout] { "type": "success", "body": "We're slow-releasing saving accounts to a few partners in Q2 2020 with a full public release in Q3 2020. If you're interested, please email, [email protected]" } [/block] Below is a quick high-level overview of how platforms are able to interact with savings accounts. This product is still in beta and we're taking feedback: ## 1. Create Wyre Account Create an account on Wyre and message [email protected] that you'd like the savings feature activated for your account. You will need to sign a short agreement prior to starting. ## 2.) Creating Crypto Savings Account Create a sub-wallet within your account and give it the "savings" label. This will be your dedicated savings account. Within this wallet, you'll have dedicated USDC, BTC, DAI, and ETH addresses. **PLEASE NOTE:** - you're able to send any support ERC-20 currency to your wallet ( USDC, DAI, ETH) and all of their associate rates are listed within the savingRatePercentages. ## 3.) Transferring Balances in and out of Account Throughout the month, you will send money in and out of your dedicated savings sub-wallet. Funds need to be in the wallet for over 24 hours to start accruing interest. You'll need to use the Transfer API to accomplish this (for balances located within your Wyre Account) OR simply send money to the deposit addresses located within your savings account. Start here if you're unfamiliar on how you can use transfers to move money around Wyre: https://docs.sendwyre.com/docs/transfer-resources ## 4.) Receiving Interest and Reviewing Account Balance You're able to review your "pendingInterestBalances" (the interest balance that has accumulated since the last interest payment). Interest payments will be paid out monthly in the deposited source cryptocurrency. To review balances, you'll need to use 1 field: - `walletId` - The identifier for the wallet Reach out to us if you have any more questions.