{"_id":"5ce71def6e0eca02789be794","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":"54eb8076867e1917009b7160","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-23T22:25:51.115Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n  \"ACCOUNT\": { // general account limits on ins/outs\n    \"24\": { // 1 day\n      \"BTC\": {\n        \"in\": 5.0, // deposit limit\n        \"out\": 5.0, // withdrawal limit\n        \"availIn\": 5.0,\n        \"availOut\": 5.0\n      }\n    },\n    \"168\": { // 1 week\n      \"USD\": {\n        \"in\": 20.0,\n        \"out\": 20.0,\n        \"availIn\": 20.0,\n        \"availOut\": 20.0\n      }\n    }\n  },\n  \"ACH\": { // limits which apply solely to ACH transactions\n    \"24\": { // 1 day\n      \"USD\": {\n        \"in\": 10000.0, // deposit limit\n        \"out\": 10000.0, // withdrawal limit\n        \"availIn\": 10000.0,\n        \"availOut\": 10000.0\n      }\n    },\n    \"168\": { // 1 week\n      \"USD\": {\n        \"in\": 20000.0,\n        \"out\": 20000.0,\n        \"availIn\": 20000.0,\n        \"availOut\": 20000.0\n      }\n    }\n  },\n  \"DEBIT_CARD\": { /* as above, apply solely to debit card transactions */ }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[],"url":"/v3/limits"},"isReference":true,"order":12,"body":"All accounts have limitations in the total amount of funds that can move into and out of them. These limits apply even in circumstances where the funds are not remaining on a Wyre account balance, as the limits apply to the movement of funds.\n\nThe limits object returned groups all limit information by context. The highest level is the `ACCOUNT` context; this determines the general limits available for the account, regardless of the type of financial connections involved.\n\nWithin each context, the limits are then grouped by their time window, reflected as a number of hours. `24` is one day, `168` is one week, and so on. The most restrictive limit always applies. \n\nWithin each time window, all active currencies will have a limit entry which details the limit and its present usage. These entries each contain 4 keys:\n\n- `in`: The total limit on incoming funds to the Wyre platform\n- `out`: The total limit on outgoing funds from the Wyre platform\n- `availIn`: Remaining incoming quota\n- `availOut`: Remaining outgoing quota\n\nWe carry limits into each of the contexts that they apply within. This means that if you're trying to check the limits in the context of an `ACH` transaction, you need only look at the `ACH` context; you do not need to additionally look at the `ACCOUNT` context. Any broader limitations will be present on the other contexts.\n\nThe contexts presently available are:\n\n- `DEBIT_CARD`: All debit card transactions limits\n- `ACH`: All ACH transaction limits\n- `ACCOUNT`: As mentioned above, general account limitations\n\nLimits are continuously rolling so there is no global \"reset\" time. For example, if you submit a transaction which consumes your full `24`-hour limit quota, you must wait 24 hours from time of submission before the quota refills.","excerpt":"Retrieve active limitations for movement of funds","slug":"limits","type":"endpoint","title":"Limits"}

getLimits

Retrieve active limitations for movement of funds

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

All accounts have limitations in the total amount of funds that can move into and out of them. These limits apply even in circumstances where the funds are not remaining on a Wyre account balance, as the limits apply to the movement of funds. The limits object returned groups all limit information by context. The highest level is the `ACCOUNT` context; this determines the general limits available for the account, regardless of the type of financial connections involved. Within each context, the limits are then grouped by their time window, reflected as a number of hours. `24` is one day, `168` is one week, and so on. The most restrictive limit always applies. Within each time window, all active currencies will have a limit entry which details the limit and its present usage. These entries each contain 4 keys: - `in`: The total limit on incoming funds to the Wyre platform - `out`: The total limit on outgoing funds from the Wyre platform - `availIn`: Remaining incoming quota - `availOut`: Remaining outgoing quota We carry limits into each of the contexts that they apply within. This means that if you're trying to check the limits in the context of an `ACH` transaction, you need only look at the `ACH` context; you do not need to additionally look at the `ACCOUNT` context. Any broader limitations will be present on the other contexts. The contexts presently available are: - `DEBIT_CARD`: All debit card transactions limits - `ACH`: All ACH transaction limits - `ACCOUNT`: As mentioned above, general account limitations Limits are continuously rolling so there is no global "reset" time. For example, if you submit a transaction which consumes your full `24`-hour limit quota, you must wait 24 hours from time of submission before the quota refills.