> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# افتح بوابة طريقة الدفع

> إنشاء رابط بوابة Stripe قصير الأجل لحساب فوترة مسجل الدخول.

استخدم هذا الإجراء من **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` يشير إلى فشل مزود أو خدمة حساب؛ تشرح الرسالة
الخطوة التالية. لا يؤدي فشل البحث عن الحساب إلى إنشاء عميل مزود آخر.


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/billing/portal
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks هي بنية تحتية عالمية للتحقق من المستندات وبيانات الاعتماد والأصول
    الرقمية.يحدد هذا المواصفات واجهة برمجة التطبيقات (API) الأساسية للتفاعل مع
    خدمات Truthlocks.


    ## عناوين URL الأساسية

    - **الإنتاج**: `https://api.truthlocks.com`

    - **البيئة التجريبية (Sandbox)**: `https://sandbox-api.truthlocks.com`


    ## المصادقة

    - **مفاتيح API**: استخدم رأس `X-API-Key` للعمليات من جهاز إلى جهاز

    - **رموز Bearer**: استخدم `Authorization: Bearer <jwt>` للعمليات التي يبدأها
    المستخدم


    ## هوية المستأجر

    في بيئة الإنتاج، تُستمد هوية المستأجر من السياق المصادق عليه (مفتاح API أو
    JWT).

    يتم تجاهل رأس `X-Tenant-ID` في بيئة الإنتاج لمنع الانتحال.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: واجهة برمجة تطبيقات الإنتاج
  - url: https://sandbox-api.truthlocks.com
    description: بيئة اختبار (Sandbox)
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: إدارة مفاتيح ورموز API
  - name: Issuers
    description: تسجيل المصدر وإدارة الثقة
  - name: Keys
    description: إدارة المفاتيح التشفيرية لجهات الإصدار
  - name: Attestations
    description: دورة حياة الإشهاد (السك، الإلغاء، الاستبدال)
  - name: Verification
    description: حزم التحقق والإثبات للإشهاد
  - name: Governance
    description: سير عمل حوكمة المصدر (للمسؤول فقط)
  - name: Identity
    description: إدارة المنظمة والمستخدمين والأدوار
  - name: Audit
    description: استعلامات أحداث التدقيق
  - name: Tenant Console
    description: ملف تعريف المستأجر ونقاط نهاية دورة الحياة
  - name: Health
    description: نقاط نهاية صحة الخدمة وجاهزيتها
  - name: Risk
    description: استيعاب إشارة المخاطر واكتشاف الاحتيال
  - name: Risk Enforcement
    description: إجراءات إنفاذ المخاطر — الحظر والتحدي والحجر والتكوين
  - name: Billing
    description: إدارة الفوترة والاشتراكات والإضافات
  - name: Machine Identity
    description: >-
      بروتوكول هوية وكيل الآلة (MAIP) — تسجيل الوكيل، الجلسات، الثقة، الشهادة،
      الامتثال، التنسيق، والمراقبة
externalDocs:
  description: واجهة برمجة تطبيقات الشفافية للقراءة فقط (مواصفات خدمة منفصلة)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/portal:
    post:
      tags:
        - Billing
      summary: افتح بوابة طريقة الدفع
      description: >-
        يتطلب حسابًا بشريًا مسجلاً الدخول. يمكن لمسؤولي مساحة العمل ومديري
        الفواتير على مستوى المستأجر تهيئة عميل Stripe مرتبط وفتح بوابة طريقة
        الدفع الخاصة به. لا يتم إنشاء أي دفعة أو اشتراك بواسطة هذا الطلب. مفاتيح
        API غير مقبولة.
      operationId: billing.portal
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - return_url
              properties:
                provider:
                  type: string
                  enum:
                    - stripe
                  default: stripe
                  description: Stripe هو مزود بوابة الخدمة الذاتية المدعوم.
                return_url:
                  type: string
                  format: uri
                  example: https://console.truthlocks.com/settings/billing
                  description: >-
                    عنوان HTTPS على console.truthlocks.com لجلسات العمل أو
                    verify.truthlocks.com لجلسات المستهلك.
      responses:
        '200':
          description: رابط بوابة طريقة الدفع قصير الأجل؛ لا يؤكد الدفع.
          content:
            application/json:
              schema:
                type: object
                required:
                  - portal_url
                properties:
                  portal_url:
                    type: string
                    format: uri
        '400':
          description: طلب غير صالح أو عنوان إرجاع.
        '401':
          description: تسجيل الدخول مطلوب.
        '403':
          description: >-
            مطلوب حساب بشري مع إمكانية الوصول إلى إدارة الفواتير؛ يتم رفض مفاتيح
            API.
        '422':
          description: لا يدعم المزود بوابة الخدمة الذاتية.
        '502':
          description: لم يتمكن المزود من تهيئة العميل أو البوابة.
        '503':
          description: تعذر التحقق من حساب الفوترة أو الأذونات.
      security:
        - BearerAuth: []
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: مفتاح API للمصادقة من جهاز إلى جهاز
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT للعمليات التي يبدأها المستخدم

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.