{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v3/widget/limits/calculate","auth":"never","method":"post","examples":{"codes":[{"language":"javascript","code":"curl -X POST \\\n  API_URL/v3/widget/limits/calculate \\\n  -H 'Content-Type: application/json' \\\n  -d '{\n\t\"walletType\": \"DEBIT_CARD\",\n  \"accountId\": \"AA_BBCCDDEEDD\",\n\t\"address\": {\n\t\t\"street1\": \"1550 Bryant Street\",\n\t\t\"city\": \"San Francisco\",\n\t\t\"state\": \"CA\",\n\t\t\"postalCode\": \"94103\",\n\t\t\"country\": \"US\"\n\t}\n}'"}]},"results":{"codes":[{"name":"","code":"{\n    \"dailyTotalSpent\": 0.00,\n    \"weeklyTotalSpent\": 2.00,\n    \"yearlyTotalSpent\": 23.15,\n    \"dailyTotal\": 260.00,\n    \"weeklyTotal\": 1000.00,\n    \"yearlyTotal\": 1500.00,\n    \"dailyRemaining\": 260.00,\n    \"weeklyRemaining\": 998.00,\n    \"yearlyRemaining\": 1476.85\n}","language":"json","status":200}]},"settings":"","params":[{"name":"walletType","type":"string","default":"","desc":"Wallet type, must be either APPLE_PAY or DEBIT_CARD","required":false,"in":"body","ref":"","_id":"5df1ebd9f7bd6502401073e2"},{"name":"address","type":"string","default":"JSON","desc":"See example for payload, all fields are required.","required":false,"in":"body","ref":"","_id":"5e9b2bf843a0ca00503976e0"},{"name":"accountId","type":"string","default":"","desc":"Partner account id","required":false,"in":"body","ref":"","_id":"5ea0e370a333f800326dec85"}]},"next":{"description":"","pages":[]},"title":"Limits API","type":"endpoint","slug":"limits-api","excerpt":"End-point to check current limits for a given wallet order billing address.","body":"To quote current limits you should place a POST call with the target billing address that will be used in the order. Country **must** be a valid 2 characters [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. \n\nThe limit check conditions are as follows: Daily limits, Weekly limits, Yearly limits\n\nThe parameter `accountId` is completely optional. For partners with custom limits, they must include their Wyre's accountId so users will inherit custom limits. If no specified will fall back to standard limits. \n\nIf the user exceeds the daily limit, but still have a weekly limit to spend he should wait until tomorrow. Any order above ***dailyRemaining***, *weeklyRemaining* or *yearlyRemaining* will reject the order. \n\nCountries supported are United States, Australia, Austria, Belgium, Canada, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hong Kong, Ireland, Italy, Latvia, Lithuania, Luxembourg, Mexico, The Netherlands, New Zealand, Norway, Poland, Portugal, Slovakia, Slovenia, Spain, Sweden, Switzerland.","updates":[],"order":999,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e9b2a624f546a00336a9f35","createdAt":"2020-04-18T16:27:14.745Z","user":"5dcd9f0b28d74f003b86eca6","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Widget","slug":"wyre-sdk","order":1,"from_sync":false,"reference":true,"_id":"5bc63538e5a6ba000d22ee6d","project":"550f74bb6fc8130d0038aad3","version":"550f75de61d9d30d00af9e01","createdAt":"2018-10-16T19:00:08.331Z","__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"],"_id":"550f75de61d9d30d00af9e01","__v":18,"releaseDate":"2015-03-23T02:09:34.221Z","project":"550f74bb6fc8130d0038aad3","createdAt":"2015-03-23T02:09:34.221Z","forked_from":"550f74bb6fc8130d0038aad6"},"project":"550f74bb6fc8130d0038aad3","__v":6}

postLimits API

End-point to check current limits for a given wallet order billing address.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

walletType:
string
Wallet type, must be either APPLE_PAY or DEBIT_CARD
address:
stringJSON
See example for payload, all fields are required.
accountId:
string
Partner account id

Examples


Result Format


Documentation

To quote current limits you should place a POST call with the target billing address that will be used in the order. Country **must** be a valid 2 characters [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. The limit check conditions are as follows: Daily limits, Weekly limits, Yearly limits The parameter `accountId` is completely optional. For partners with custom limits, they must include their Wyre's accountId so users will inherit custom limits. If no specified will fall back to standard limits. If the user exceeds the daily limit, but still have a weekly limit to spend he should wait until tomorrow. Any order above ***dailyRemaining***, *weeklyRemaining* or *yearlyRemaining* will reject the order. Countries supported are United States, Australia, Austria, Belgium, Canada, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hong Kong, Ireland, Italy, Latvia, Lithuania, Luxembourg, Mexico, The Netherlands, New Zealand, Norway, Poland, Portugal, Slovakia, Slovenia, Spain, Sweden, Switzerland.