reseller
POST /v1/reseller/client-wallets/{walletId}/adjustments
Correct a client's balance.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز reseller.manage باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
جایی که شناسه سازمان شما قرار میگیرد
این نقطه پایانی org_id را به عنوان یک پارامتر پرسوجو میپذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجارهای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.
شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواستهایی که ارسال میکنید یکسان است.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X POST https://api.zinndigital.com/v1/reseller/client-wallets/{walletId}/adjustments \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "amount_minor": <integer>, "reason": <string> }'وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
Signed — positive credits, negative takes back. ⛔ A negative adjustment that would put the client below zero is refused with 422 naming what is available: you may correct your own mistake, you may not push a customer into debt. reason is required and the client sees it on their statement. A wallet belonging to another reseller answers 404, never 403, so this is not an existence oracle. Requires reseller.manage.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
walletId (path) | Uuid | بله | — |
org_id (query) | Uuid | خیر | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404… |
بدنه درخواست
| نام | نوع | الزامی | چیست |
|---|---|---|---|
amount_minor | integer | بله | Signed minor units. ⛔ Cannot take the client below zero. |
reason | string | بله | Required, and the client sees it on their statement. An unexplained movement of somebody else's money is the first thing an audit asks about. |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
org_id | Uuid | بله | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
currency | string | بله | — |
balance_minor | integer | بله | What you are owed — the float your provider is holding for you. |
spendable_minor | integer | بله | What you can spend today. Lower than balance_minor when your provider's reseller programme is suspended: the deposit is still yours, but nobody is delivering service against… |
reseller_org_id | Uuid | null | خیر | The provider whose float this is. |
entries | ClientWalletEntry[] | بله | — |
other_floats | ClientOtherFloat[] | بله | Balances a previous provider still holds for you. ⛔ Normally empty. A client who changed provider is still owed what the old one took; omitting it would make that money… |
provider | string<reseller, zinn> | خیر | ⭐ Who is holding this money. One screen serves both, because "credit you hold with your provider" is one question whose answer depends on the customer, not on the feature.… |
purses | WalletPurse[] | خیر | The owner's "one ledger, named purses" — a balance may be restricted to a kind of spending. ⛔ Empty for a reseller float, which has no purses. A purse whose authoritative store… |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 422 · 429