مرجع API

تهيئة قاعدة صرف

ينشئ قاعدة صرف للحساب أو يحدّثها بعد صلاحية withdrawals:approve وضوابط السياسة المالية.

POSThttps://api.sparkglim.net/api/white-label/portal/reseller/payout-rules

نموذج الوصول

نموذج الوصول: جلسة SparkGlim وصلاحيات العضو
الصلاحية المطلوبة: withdrawals:approve
التوفر الموثّق: منفذ في المصدر

التوفر موثق من المصدر وليس ضمانًا لتشغيل الإنتاج.

استخدم مسار أعضاء فريق المنشئ؛ ولا تمنح إعادة البيع وصولًا غير محدود للبيانات أو الإدارة.

الترويسات

الاسم	النوع	التحقق من المدخلات
`Authorization`مطلوب جلسة SparkGlim حاملة قائمة؛ وتحدد عضوية الحساب والصلاحيات المعينة السماح بكل عملية.	`string`	التحقق: رمز Bearer لجلسة مصادقة موجودة.

الطلب

الاسم	النوع	التحقق من المدخلات
`ownerMemberId`اختياري سجل علاقة أو مراجعة قائم ضمن الحساب؛ ويتحقق الخادم من الملكية والصلاحيات اللازمة.	`string\|null`	التحقق: UUID.
`ownerCreatorId`اختياري سجل علاقة أو مراجعة قائم ضمن الحساب؛ ويتحقق الخادم من الملكية والصلاحيات اللازمة.	`string\|null`	التحقق: UUID.
`status`اختياري الحالة المدعومة المطلوبة؛ وتتحكم قواعد الموافقة في النشر والوصول.	`enum`	التحقق: active \| paused \| revoked.
`currency`اختياري قيمة سياسة صرف ضمن الحساب؛ ويحتفظ الخادم بسلطة الأرصدة والرسوم والموافقات والتسوية.	`string`	التحقق: ISO3.
`resellerFeeRate`اختياري قيمة سياسة صرف ضمن الحساب؛ ويحتفظ الخادم بسلطة الأرصدة والرسوم والموافقات والتسوية.	`number`	التحقق: >=0.
`sparkglimFeeRate`اختياري قيمة سياسة صرف ضمن الحساب؛ ويحتفظ الخادم بسلطة الأرصدة والرسوم والموافقات والتسوية.	`number`	التحقق: >=0.
`payoutHoldHours`اختياري قيمة سياسة صرف ضمن الحساب؛ ويحتفظ الخادم بسلطة الأرصدة والرسوم والموافقات والتسوية.	`integer`	التحقق: >=0.
`minWithdrawalAmount`اختياري قيمة سياسة صرف ضمن الحساب؛ ويحتفظ الخادم بسلطة الأرصدة والرسوم والموافقات والتسوية.	`number`	التحقق: >=0.
`maxWithdrawalAmount`اختياري قيمة سياسة صرف ضمن الحساب؛ ويحتفظ الخادم بسلطة الأرصدة والرسوم والموافقات والتسوية.	`number\|null`	التحقق: >=0.
`autoEscalateAboveAmount`اختياري قيمة سياسة صرف ضمن الحساب؛ ويحتفظ الخادم بسلطة الأرصدة والرسوم والموافقات والتسوية.	`number\|null`	التحقق: >=0.
`metadata`اختياري بيانات JSON إضافية يقبلها المخطط؛ ولا تتجاوز التفويض أو الأسعار أو الملكية.	`object`	التحقق: كائن JSON.

الطلب

تصف الأمثلة العقد ولا تُنفذ. استخدم سجلات اختبار مصرحًا بها، ولا تلصق أسرارًا حقيقية في هذه الصفحات.

POST /api/white-label/portal/reseller/payout-rules

http

POST /api/white-label/portal/reseller/payout-rules HTTP/1.1
Host: api.sparkglim.net
Authorization: Bearer <EXISTING_SESSION_TOKEN>
Content-Type: application/json

{
  "currency": "GHS",
  "payoutHoldHours": 24,
  "minWithdrawalAmount": 0
}

الاستجابة

استجابة النجاح · HTTP 201

json

{
  "success": true,
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "status": "pending"
  }
}

استجابة الخطأ · HTTP 400

json

{
  "success": false,
  "error": "<ERROR_MESSAGE>"
}

تستخدم أخطاء التحقق والصلاحيات والموارد والأعطال حالة HTTP وبنية الخطأ الخاصة بالمعالج.

الحدود وإعادة المحاولة

الحد الافتراضي: 100 طلب لكل عنوان IP خلال 60 ثانية، مع ضوابط إضافية حسب المورد.

توافق المصدر

تتطلب العمليات المصرح بها اختبارًا خاصًا بالحساب.

server/src/api/router.ts
server/src/api/routes/white-label.ts
server/src/white-label/reseller-service.ts
server/src/white-label/schemas.ts

نموذج الوصول

الترويسات

الطلب

الطلب

الاستجابة

الحدود وإعادة المحاولة

توافق المصدر

تابع التطوير