reseller

POST `/v1/reseller/client-wallets`

Open a client's float, or add credit to it.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن reseller.manage؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

حيث يتم إدخال معرف مؤسستك

تأخذ نقطة النهاية هذه org_id كمعلمة استعلام. اتركه فارغاً ليغطي الاستدعاء شجرة مستأجريك بالكامل، أو أرسله لتضييق نطاق الاستدعاء ليشمل منظمة واحدة.

معرف مؤسستك موجود على شاشة مفاتيح واجهة برمجة التطبيقات (API) في لوحة تحكمك، بجوار المفتاح نفسه. وهو نفس المعرف في كل طلب تجريه.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X POST https://api.zinndigital.com/v1/reseller/client-wallets \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "client_org_id": <Uuid>, "currency": <string>, "amount_minor": <integer>, "reason": <string> }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

Records a deposit you took **outside** our gateway — a bank transfer, cash, an invoice settled directly — or a goodwill credit, or a balance migrated in from whatever you used before. It lands as an adjustment on the client's ledger with your reason on the line they read. Requires `reseller.manage`. ⛔ This is the only way to bring a client's float into existence. Every other write on this surface needs a `wallet_id`, and until this endpoint a wallet only appeared once the client had paid by card — so a reseller could see an empty liability register with no control on it, which is what was measured on production on 2026-08-16 (`ClientWallet` held zero rows estate-wide). ⛔ It is deliberately **not** a card charge. `POST /v1/wallet/top-ups` is that, it is the client's own action, and it settles into your gateway. Money that never moved through a gateway must not be recorded as though it had. A client that does not bill back to you is a **404**, never a 403 — this endpoint must not become a way to discover who else resells to whom.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`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.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`client_org_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`currency`	`string`	نعم	—
`amount_minor`	`integer`	نعم	Strictly positive. Opening a float is a DEPOSIT; taking money off a client is a correction and belongs on the adjustments endpoint, which has the below-zero guard and an existin…
`reason`	`string`	نعم	The client reads this on their own statement of account.

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`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 again…
`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 disa…
`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 stor…

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422 · 429

POST /v1/reseller/client-wallets