{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v3/orders/quote/partner","auth":"optional","method":"post","examples":{"codes":[{"language":"javascript","code":"curl -X POST \\\n  API_URL/v3/orders/quote/partner \\\n  -H 'Authorization: Bearer WYRE_SECRET_KEY' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Postman-Token: 7ad1cd47-a7bc-4126-9333-4983f4c6da5d' \\\n  -H 'cache-control: no-cache' \\\n  -d '{\n    \"amount\": \"5.0\",\n    \"sourceCurrency\": \"USD\",\n    \"destCurrency\": \"ETH\",\n    \"dest\": \"ethereum:xxxxxxxxxxx\",\n    \"accountId\": \"AC_xxxxxxxx\",\n     \"country\": \"US\"\n}'"}]},"results":{"codes":[{"name":"","code":"{\n    \"sourceCurrency\": \"USD\",\n    \"sourceAmount\": 5.95,\n    \"destCurrency\": \"ETH\",\n    \"destAmount\": 0.009880239520958084,\n    \"exchangeRate\": 0.001976047904191616838,\n    \"equivalencies\": {\n        \"CAD\": 4.95,\n        \"USDC\": 0.009920,\n        \"BTC\": 0.00040198,\n        \"ETH\": 0.009880239520958084,\n        \"GBP\": 4.95,\n        \"DAI\": 4.154151233875968493,\n        \"AUD\": 3.87,\n        \"EUR\": 4.95,\n        \"WETH\": 0.009880239520958084,\n        \"USD\": 4.95,\n        \"MXN\": 4.95\n    },\n    \"fees\": {\n        \"ETH\": 0.001000000000000000,\n        \"USD\": 0.45\n    }\n}","language":"json","status":200}]},"settings":"","params":[{"name":"amount","type":"string","default":"","desc":"sourceAmount of a wallet order (e.g. purchase amount)","required":false,"in":"body","ref":"","_id":"5df1ebd9f7bd6502401073e2"},{"name":"sourceCurrency","type":"string","default":"","desc":"The currency (ISO 3166-1 alpha-3) to withdraw from the source wallet (e.g. USD)","required":false,"in":"body","ref":"","_id":"5df1ebd9f7bd6502401073e1"},{"name":"destCurrency","type":"string","default":"","desc":"The currency (ISO 3166-1 alpha-3) to deposit to dest wallet (e.g. BTC)","required":false,"in":"body","ref":"","_id":"5df1ebd9f7bd6502401073e0"},{"name":"dest","type":"string","default":"","desc":"A digital currency address to send the digital currency to.","required":false,"in":"body","ref":"","_id":"5df1ebd9f7bd6502401073df"},{"name":"accountId","type":"string","default":"","desc":"Your Partner Account ID. This associates purchases created inside the widget with you.","required":false,"in":"body","ref":"","_id":"5e7143f6d39643006b851319"},{"name":"country","type":"string","default":"","desc":"Country code ISO Alpha 2 code in uppercase. Must be one of the countries supported by Wyre","required":false,"in":"body","ref":"","_id":"5ea70610dca92700638885da"},{"name":"walletType","type":"string","default":"DEBIT_CARD","desc":"APPLE_PAY or DEBIT_CARD","required":false,"in":"body","ref":"","_id":"5f231f9aa634f20731f0baeb"},{"name":"amountIncludeFees","type":"boolean","default":"false","desc":"If `true`, fees are deducted from the `sourceAmount`","required":false,"in":"body","ref":"","_id":"5fdacc2d5594e30018676597"},{"name":"sourceAmount","type":"string","default":"","desc":"Use this parameter in place of `amount` when `amountIncludeFees` is equal to true.","required":false,"in":"body","ref":"","_id":"5fdacc2d5594e30018676596"},{"name":"destAmount","type":"string","default":"","desc":"Use this parameter when amountIncludeFees is equal to true.","required":false,"in":"body","ref":"","_id":"5fdacc2d5594e30018676595"}]},"next":{"description":"","pages":[]},"title":"Wallet Order Quotation","type":"endpoint","slug":"wallet-order-quotation","excerpt":"Quote a Wallet Order","body":"Use this endpoint to quote a wallet order if you use our API instead of the Hosted Widget.\n\nTo quote on different `sourceCurrency` please set it to AUD, USD, GBP, CAD and EUR. Limits are always calculated on USD using the current market rates between sourceCurrency and USD. \n\nThere are two ways to specify the \"amount\" field. \n-  `amount` (will always be the fiat amount without fees included)\n- `sourceAmount`/`destAmount` (fiat amount, crypto amount respectively, use only one, not both)\n\nWhen using `sourceAmount` or `destAmount` you need to specify a boolean flag `amountIncludeFees` meaning if that amount has fees already included or not. \nThis approach does not lock the rates. It can ***slightly change*** form the moment of the quote and the moment the order is placed.  If you want rates locking, please use [Wallet Order Reservations](doc:wallet-order-reservations) ] instead. \n\nEx, by setting `sourceAmount = 100` and `amountIncludeFees = false` will allow you to receive the exact 100 (converted into crypto) in your wallet, and fees will be added on top (100 + fees will be charged from user) . If `amountIncludeFees = true`, fees will be subtracted from amount, `100 - fees` will be the amount received in the wallet.","updates":[],"order":8,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e7142916b847800187d4d69","createdAt":"2020-03-17T21:35:13.563Z","user":"5dcd9f0b28d74f003b86eca6","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Wyre Checkout","slug":"wyre-sdk","order":3,"from_sync":false,"reference":true,"_id":"5bc63538e5a6ba000d22ee6d","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-10-16T19:00:08.331Z","__v":1},"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":17,"parentDoc":null}

postWallet Order Quotation

Quote a Wallet Order

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

amount:
string
sourceAmount of a wallet order (e.g. purchase amount)
sourceCurrency:
string
The currency (ISO 3166-1 alpha-3) to withdraw from the source wallet (e.g. USD)
destCurrency:
string
The currency (ISO 3166-1 alpha-3) to deposit to dest wallet (e.g. BTC)
dest:
string
A digital currency address to send the digital currency to.
accountId:
string
Your Partner Account ID. This associates purchases created inside the widget with you.
country:
string
Country code ISO Alpha 2 code in uppercase. Must be one of the countries supported by Wyre
walletType:
stringDEBIT_CARD
APPLE_PAY or DEBIT_CARD
amountIncludeFees:
booleanfalse
If `true`, fees are deducted from the `sourceAmount`
sourceAmount:
string
Use this parameter in place of `amount` when `amountIncludeFees` is equal to true.
destAmount:
string
Use this parameter when amountIncludeFees is equal to true.

Examples


Result Format


Documentation

Use this endpoint to quote a wallet order if you use our API instead of the Hosted Widget. To quote on different `sourceCurrency` please set it to AUD, USD, GBP, CAD and EUR. Limits are always calculated on USD using the current market rates between sourceCurrency and USD. There are two ways to specify the "amount" field. - `amount` (will always be the fiat amount without fees included) - `sourceAmount`/`destAmount` (fiat amount, crypto amount respectively, use only one, not both) When using `sourceAmount` or `destAmount` you need to specify a boolean flag `amountIncludeFees` meaning if that amount has fees already included or not. This approach does not lock the rates. It can ***slightly change*** form the moment of the quote and the moment the order is placed. If you want rates locking, please use [Wallet Order Reservations](doc:wallet-order-reservations) ] instead. Ex, by setting `sourceAmount = 100` and `amountIncludeFees = false` will allow you to receive the exact 100 (converted into crypto) in your wallet, and fees will be added on top (100 + fees will be charged from user) . If `amountIncludeFees = true`, fees will be subtracted from amount, `100 - fees` will be the amount received in the wallet.