الانتقال إلى المحتوى الرئيسي
POST
افتح بوابة طريقة الدفع
استخدم هذا الإجراء من Console → Settings → Billing → Payment methods أو من صفحة فواتير المستهلك. تتطلب جلسة بشرية مسجلة الدخول. لا يمكن لمفاتيح API فتح بوابة عملاء. تتطلب مساحات عمل الأعمال مسؤول مساحة عمل نشط أو دور على مستوى المستأجر مع إذن إدارة الفواتير. لمساحة عمل قائمة على الاستخدام بدون عميل Stripe مرتبط، البوابة الصريحة يُهيئ الطلب ويربط هذا العميل باستخدام البريد الإلكتروني للحساب الموثق. لا يؤدي فتح البوابة إلى فرض رسوم على بطاقة، أو إنشاء اشتراك، أو تغيير الخطة.

الطلب

عيّن provider إلى stripe (الافتراضي). لا توفر Flutterwave حاليًا بوابة الخدمة الذاتية من خلال نقطة النهاية هذه. Paystack غير مدعوم هنا. عيّن return_url إلى عنوان HTTPS على console.truthlocks.com لعمل تجاري جلسة أو verify.truthlocks.com لجلسة المستهلك. يتم رفض المضيفين الآخرين.

الاستجابة

portal_url هو رابط Stripe قصير الأجل. افتحه لإضافة أو تحديث تفاصيل الدفع واطلع على فواتير Stripe المتاحة. تكوين بوابة طريقة الدفع في Truthlocks لا تمكن تغييرات الاشتراك أو الإلغاء؛ استخدم صفحة الفواتير المناسبة صفحة لتلك الإجراءات. تعامل مع هذا الرابط على أنه خاص واطلب رابطًا جديدًا في كل مرة.

الأخطاء

تُرجع الأخطاء JSON مع code و error. 403 يعني أن الشخص المسجل دخوله لا يستطيع إدارة حساب الفواتير هذا. 422 يحدد مزودًا غير مدعوم. 502 أو 503 يشير إلى فشل مزود أو خدمة حساب؛ تشرح الرسالة الخطوة التالية. لا يؤدي فشل البحث عن الحساب إلى إنشاء عميل مزود آخر.

التفويضات

Authorization
string
header
مطلوب

JWT للعمليات التي يبدأها المستخدم

الجسم

application/json
return_url
string<uri>
مطلوب

عنوان HTTPS على console.truthlocks.com لجلسات العمل أو verify.truthlocks.com لجلسات المستهلك.

مثال:

"https://console.truthlocks.com/settings/billing"

provider
enum<string>
افتراضي:stripe

Stripe هو مزود بوابة الخدمة الذاتية المدعوم.

الخيارات المتاحة:
stripe

الاستجابة

رابط بوابة طريقة الدفع قصير الأجل؛ لا يؤكد الدفع.

portal_url
string<uri>
مطلوب