Debit a subscriber wallet
POST
/api/v1/users/{id}/withdraw
prm_users_withdrawal
The inverse of deposit. Refuses to take the balance below zero unless allow_negative is set.
At a glance
- Authentication
- Staff token or session
- Requires permission
-
prm_users_withdrawalWithdraw / settle user debt - Rate limit
t_mutate- Idempotency key
request_id
Parameters
| Parameter | Description |
|---|---|
idrequired
path · integer
|
Subscriber id. |
amountrequired
body · number
|
Major units. |
request_idrequired
body · string
|
Idempotency key. |
allow_negative
body · boolean
|
Permit the withdrawal to drive the balance below zero. |
Errors
| Code | When it is returned |
|---|---|
ERR_CONFLICT409
|
the request_id is already held by a different ledger line |