مرجع API السحوبات

مرجع كامل لنقاط نهاية API السحوبات. أدِر إعدادات السحب وأنشئ طلبات السحب.

قيم استراتيجية السحب

الحقل strategy رقم في الإعدادات وفي طلبات السحب:

القيمة	الاسم	الوصف
1	multi-network	تحويلات مباشرة لكل شبكة؛ دون جسر بين الشبكات.
2	bridge	استخدام Relay للعبور عندما يتطلب عرض السعر ذلك؛ وإلا فمثل multi-network.

راجع استراتيجية السحب للتفاصيل. ولمعرفة كيف يُدفع الغاز (paymaster، والتمويل الذاتي، والمحفظة الساخنة)، راجع تمويل الغاز والرسوم.

أنواع الشبكات الصالحة

تُفهرس عناوين السحب حسب نوع الشبكة. المفاتيح الصالحة هي: evm وsolana وbitcoin وtron وcosmos وpolkadot وmove وton. استخدمها كمفاتيح في:

• إعدادات السحب — addresses: مثل { "evm": "0x...", "solana": "...", "bitcoin": "bc1q..." }
• Payment Intents وروابط الدفع — withdrawal_addresses: بالشكل نفسه

يُتحقق من كل عنوان وفق نوع شبكته (EVM وسولانا وبيتكوين وغيرها). لسرد الشبكات حسب النوع استخدم GET /payments/networks?chainType=evm (أو نوع شبكة صالحًا آخر). راجع الحدود الدنيا للدفع للحدود الدنيا لكل نوع شبكة.

عناوين السحب لكل دفعة (حسب نوع الشبكة)

عند إنشاء Payment Intent أو رابط دفع، يمكنك اختياريًا تعيين withdrawal_addresses (أو withdrawalAddresses للروابط) ككائن مفتاح-قيمة. المفاتيح أنواع شبكات من جدول الشبكات (مثل evm وsolana وbitcoin). وكل قيمة هي عنوان السحب لتلك الشبكة. إذا حُذف أو كان فارغًا لشبكة ما، يُستخدم الافتراضي في حسابك من إعدادات السحب لذلك النوع. ويُتحقق من العناوين لكل شبكة (EVM وسولانا وبيتكوين وغيرها).

الرابط الأساسي

https://api.orcarail.com/api/v1

إعدادات السحب

الحصول على إعدادات السحب

احصل على إعدادات السحب للمستخدم المصادَق عليه (العناوين حسب نوع الشبكة والاستراتيجية). isEnabled دائمًا true: فالسحوبات تلقائية.

GET /withdrawals/settings

المصادقة

• رمز Bearer (JWT) — مطلوب

الاستجابة

{
  "id": "uuid",
  "userId": "uuid",
  "addresses": {
    "evm": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "solana": "GTtzwxqy67xx9DVESJjx28TgXqpc8xTqtiytgNMaQBTE",
    "bitcoin": "bc1q..."
  },
  "isEnabled": true,
  "strategy": 1,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T12:00:00.000Z"
}

مفاتيح addresses أنواع شبكات (evm وsolana وbitcoin وtron وcosmos وpolkadot وmove وton). يُتحقق من كل عنوان لتلك الشبكة. تعيد null إن لم توجد إعدادات بعد.

تحديث إعدادات السحب

أنشئ إعدادات السحب أو حدّثها.

PUT /withdrawals/settings

المصادقة

• رمز Bearer (JWT) — مطلوب

جسم الطلب

كل الحقول اختيارية. ضمّن فقط الحقول المراد تحديثها.

المعامل	النوع	مطلوب	الوصف
addresses	object	لا	عناوين السحب حسب نوع الشبكة. المفاتيح: evm وsolana وbitcoin وغيرها. القيم: سلسلة العنوان لتلك الشبكة. يُتحقق منها مقابل شبكة من ذلك النوع.
strategy	number	لا	استراتيجية السحب (مثل multi-network وbridge)

الاستجابة

بالشكل نفسه لـ GET؛ وaddresses هو كائن المفتاح-القيمة. يلزم عنوان واحد على الأقل. يُتحقق من العناوين مقابل شبكات من وضع المؤسسة نفسه: تقبل مؤسسة sandbox عناوين الشبكات التجريبية (مثل بيتكوين tb1…)، والمؤسسة الحية عناوين الشبكة الرئيسية. يؤدي حفظ الإعدادات إلى تشغيل السحوبات التلقائية؛ ولا يوجد سحب يدوي.

طلبات السحب

سرد طلبات السحب

اسرد طلبات السحب للمستخدم المصادَق عليه.

GET /withdrawals/requests

المصادقة

• رمز Bearer (JWT) — مطلوب

معاملات الاستعلام

المعامل	النوع	مطلوب	الوصف
limit	number	لا	الحد الأقصى لعدد الطلبات المُعادة

الاستجابة

[
  {
    "id": "uuid",
    "userId": "uuid",
    "amount": "0.1",
    "tokenId": "uuid",
    "sourceNetworkId": "uuid",
    "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
    "strategy": 1,
    "status": "completed",
    "createdAt": "2024-01-01T00:00:00.000Z"
  }
]

ملخص السحوبات

الحصول على ملخص السحوبات

احصل على ملخص الأرصدة وإجماليات السحب حسب الشبكة والرمز.

GET /withdrawals/summary

المصادقة

• رمز Bearer (JWT) — مطلوب

الاستجابة

{
  "byNetwork": [
    {
      "networkId": 1,
      "networkName": "Ethereum",
      "totalAmount": "100.50",
      "totalUsdcValue": "100.50"
    }
  ],
  "byToken": [
    {
      "tokenId": 1,
      "tokenSymbol": "USDC",
      "totalAmount": "100.50",
      "totalUsdcValue": "100.50"
    }
  ],
  "totals": {
    "totalEarnedUsdc": "1250.50",
    "totalWithdrawnUsdc": "500.0",
    "remainingUsdc": "750.5"
  }
}

رموز الحالة

رمز الحالة	الوصف
200	نجاح
201	تم الإنشاء
400	طلب غير صالح
401	غير مصرّح
404	غير موجود
500	خطأ داخلي في الخادم

انظر أيضًا

• استراتيجية السحب — متعددة الشبكات مقابل الجسر وأين تُضبط الاستراتيجية
• تمويل الغاز والرسوم — paymaster والتمويل الذاتي والمحفظة الساخنة
• لوحة التحكم — ملخص لوحة التحكم بما فيه الأرصدة
• المدفوعات — روابط الدفع والمعاملات