المنتجات والروابط المدارة والاشتراكات

هذه هي موارد الأعمال المملوكة للحساب. يلزم الوصول إلى مفتاح API أو وصول حامل الشريك والإمكانيات الممكّنة المقابلة. المفتاح لا يعمل على طريق الدفع. راجع المصادقة.

للقراءة والحذف، env هو مرشح الاستعلام. لإنشاء المنتج/الرابط وتحديثاته، أرسل env في نص JSON. ملكية الشريك تأتي من بيانات الاعتماد؛ لا ترسل شريكًا آخر. يمكن أن تحتوي حقول سعر المورد على أنواع أعداد صحيحة خاصة بنقطة النهاية: يظل مبلغ المعاملة API عبارة عن سلسلة عددية صحيحة.

المنتجات

GET /api/v1/products?env=prod&limit=10
GET /api/v1/products/{id}?env=prod
POST /api/v1/products
PUT /api/v1/products/{id}
DELETE /api/v1/products/{id}?env=prod

إنشاء منتج يحدد رأسه ونصه وسعره وكميته وعملته. المنتج ليس دفعة. تستخدم استجابات القائمة البيانات/الإجمالي؛ تفاصيل المنتج واستجابات الإنشاء تستخدم البيانات. السعر المعروض هو 1 USDT بالكسور العشرية=6.

{
  "env": "prod",
  "header": "Example item",
  "text": "Example item",
  "price": 1000000,
  "qty": "1",
  "currency": "USDT"
}

روابط الدفع المدارة

GET /api/v1/links?env=prod&limit=10
POST /api/v1/links
PUT /api/v1/links/{id}
DELETE /api/v1/links/{id}?env=prod

الروابط هي موارد خادم منفصلة مع إعدادات المبلغ وتكوين الدفع والمنتجات الاختيارية. استخدم المورد الذي تم إرجاعه URL/معلومات النموذج، وليس URL المخترع. يعد رابط استلام Heth الذي تم إنشاؤه في التطبيق كائنًا مختلفًا. لا يؤدي حذف الرابط إلى استرداد دفعة تمت تسويتها بالفعل.

اشتراكات التاجر

GET /api/v1/recurrents?env=prod&limit=10
GET /api/v1/recurrents/{id}?env=prod
POST /api/v1/recurrents
PUT /api/v1/recurrents/{id}
POST /api/v1/recurrents/{id}/pause
POST /api/v1/recurrents/{id}/resume
POST /api/v1/recurrents/{id}/cancel

يتم إنشاء اشتراك من دفعة أولية ناجحة تابعة للحساب. يستخدم POST /recurrents معرف الدفع والكائن المتكرر؛ الفاصل الزمني يقبل يوميًا أو أسبوعيًا أو شهريًا أو سنويًا، مع تحديد الفترة لعدد الفواصل الزمنية. يجب على الدافع تفويض طريقة الدفع وشروط الخصم المتكررة. لا يعد إنشاء الاشتراك دليلاً على وجود إذن خصم قابل للاستخدام.

تستخدم إجراءات دورة الحياة POST /recurrents/{id}/pause و/استئناف و/إلغاء. قراءة الحالة التي تم إرجاعها؛ إلغاء الرسوم المستقبلية لا يؤدي إلى استرداد الرسوم السابقة. يدير دافع Heth تفويضات اشتراك العملات المشفرة الخاصة به من خلال جلسة المحفظة الخاصة به في الإعدادات → تفويضات الاشتراك، حيث يتم تمكين الميزة. وهذا منفصل عن إدارة اشتراكات التاجر.