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.
نظرة سريعة
- المصادقة
- رمز موظّف أو جلسة
- تتطلب صلاحية
-
prm_users_withdrawalWithdraw / settle user debt - حد المعدل
t_mutate- مفتاح عدم التكرار
request_id
المعاملات
| المعامل | الوصف |
|---|---|
idمطلوب
path · integer
|
Subscriber id. |
amountمطلوب
body · number
|
Major units. |
request_idمطلوب
body · string
|
Idempotency key. |
allow_negative
body · boolean
|
Permit the withdrawal to drive the balance below zero. |
الأخطاء
| الرمز | متى تُرجَع |
|---|---|
ERR_CONFLICT409
|
the request_id is already held by a different ledger line |