Set limits
Setting limits needs thelimits:write scope. A key that moves money (entries:write, holds:write) cannot raise its own limits, so give limits:write only to the service that decides them, such as your compliance or onboarding service.
{} to remove them all. Limits take effect at once, with no approval, and apply only to wallets.
What counts as spending
- A posted debit, and a pending debit, counts on its business date.
- A hold counts when it is placed. Capturing it does not count again, and releasing it or letting it expire gives back what was not captured.
- Voiding a pending entry gives back what it had counted.
- Reversals and adjustments approved in the console never count, and are never refused by a limit, so a mistake can always be undone.
Reading what is left
GET /v1/accounts/{id} on a wallet shows its limits and what it has used:
When a limit is reached
A debit, hold or posted credit that would go over a limit is refused withLIMIT_EXCEEDED, and nothing moves. details says which limit (limit), its value (max), what was already used (used), what is left (remaining) and the amount asked for.
Money that arrives from the bank cannot be refused, because it has already arrived. A credit to a named account that would take the wallet over maxBalance goes to the partner’s suspense account instead. The credit reports QUARANTINED, with the reason “The wallet’s balance limit would be exceeded.”, and you return it to the sender.