> ## 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.

# Ouvrir le portail de la méthode de paiement

> Créer un lien de portail Stripe de courte durée pour un compte de facturation connecté.

Utilisez cette action depuis **Console → Paramètres → Facturation → Méthodes de paiement** ou votre
page de facturation du consommateur. Elle nécessite une session humaine connectée. Les clés API ne peuvent pas ouvrir
un portail client. Les espaces de travail professionnels nécessitent un administrateur d'espace de travail actif
ou un rôle à l'échelle du locataire avec la permission de gestion de la facturation.

Pour un espace de travail basé sur l'utilisation sans client Stripe lié, le portail explicite
la demande initialise et lie ce client en utilisant l'e-mail du compte vérifié.
L'ouverture du portail ne débite pas de carte, ne crée pas d'abonnement et ne modifie pas le plan.

## Requête

Définissez `provider` sur `stripe` (la valeur par défaut). Flutterwave ne fournit pas actuellement de
portail en libre-service via ce point de terminaison. Paystack n'est pas pris en charge ici.

Définissez `return_url` sur une adresse HTTPS sur `console.truthlocks.com` pour une entreprise
session ou `verify.truthlocks.com` pour une session consommateur. Les autres hôtes sont rejetés.

## Réponse

`portal_url` est un lien Stripe de courte durée. Ouvrez-le pour ajouter ou mettre à jour les détails de paiement
et consultez les factures Stripe disponibles. La configuration du portail de paiement de Truthlocks
n'active pas les changements d'abonnement ou l'annulation ; utilisez la page de facturation appropriée
page pour ces actions. Traitez ce lien comme privé et demandez-en un nouveau à chaque fois.

## Erreurs

Les erreurs renvoient du JSON avec `code` et `error`. `403` signifie que la personne connectée ne peut pas
gérer ce compte de facturation. `422` identifie un fournisseur non pris en charge. `502` ou
`503` indique une défaillance du fournisseur ou du service de compte ; le message explique le
étape suivante. Une recherche de compte échouée ne crée pas un autre client fournisseur.


## OpenAPI

````yaml fr/mint-openapi.yaml POST /v1/billing/portal
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks est une infrastructure de vérification universelle pour les
    documents, les identifiants et les actifs numériques.

    Cette spécification définit l'API canonique pour interagir avec les services
    Truthlocks.


    ## URL de base

    - **Production** : `https://api.truthlocks.com`

    - **Sandbox** : `https://sandbox-api.truthlocks.com`


    ## Authentification

    - **Clés API** : Utilisez l'en-tête `X-API-Key` pour les opérations de
    machine à machine

    - **Jetons Bearer** : Utilisez `Authorization: Bearer <jwt>` pour les
    opérations initiées par l'utilisateur


    ## Identité du locataire

    En production, l'identité du locataire est dérivée du contexte authentifié
    (clé API ou JWT).

    L'en-tête `X-Tenant-ID` est ignoré en production pour éviter l'usurpation
    d'identité.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de production
  - url: https://sandbox-api.truthlocks.com
    description: Environnement de bac à sable
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestion des clés API et des jetons
  - name: Issuers
    description: Enregistrement de l'émetteur et gestion de la confiance
  - name: Keys
    description: Gestion des clés cryptographiques pour les émetteurs
  - name: Attestations
    description: Cycle de vie de l'attestation (créer, révoquer, remplacer)
  - name: Verification
    description: Vérification des attestations et lots de preuves
  - name: Governance
    description: Flux de travail de gouvernance de l'émetteur (administrateur uniquement)
  - name: Identity
    description: Gestion de l'organisation, des utilisateurs et des rôles
  - name: Audit
    description: Requêtes d'événements d'audit
  - name: Tenant Console
    description: Points de terminaison du profil et du cycle de vie du locataire
  - name: Health
    description: Points de terminaison de l'état et de la disponibilité du service
  - name: Risk
    description: Ingestion de signaux de risque et détection de fraude
  - name: Risk Enforcement
    description: >-
      Actions d'application des risques — blocage, défi, quarantaine et
      configuration
  - name: Billing
    description: Gestion de la facturation, des abonnements et des modules complémentaires
  - name: Machine Identity
    description: >-
      Protocole d'identité d'agent machine (MAIP) — enregistrement d'agent,
      sessions, confiance, témoin, conformité, orchestration et observabilité
externalDocs:
  description: API de transparence en lecture seule (spécification de service séparée)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/portal:
    post:
      tags:
        - Billing
      summary: Ouvrir le portail de la méthode de paiement
      description: >-
        Nécessite un compte humain connecté. Les administrateurs d'espace de
        travail et les gestionnaires de facturation à l'échelle du locataire
        peuvent initialiser un client Stripe lié et ouvrir son portail de
        méthodes de paiement. Aucun paiement ou abonnement n'est créé par cette
        requête. Les clés API ne sont pas acceptées.
      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 est le fournisseur de portail en libre-service pris
                    en charge.
                return_url:
                  type: string
                  format: uri
                  example: https://console.truthlocks.com/settings/billing
                  description: >-
                    Adresse HTTPS sur console.truthlocks.com pour les sessions
                    professionnelles ou verify.truthlocks.com pour les sessions
                    grand public.
      responses:
        '200':
          description: >-
            Lien de portail de méthode de paiement de courte durée ; ne confirme
            pas un paiement.
          content:
            application/json:
              schema:
                type: object
                required:
                  - portal_url
                properties:
                  portal_url:
                    type: string
                    format: uri
        '400':
          description: Requête ou adresse de retour invalide.
        '401':
          description: Connexion requise.
        '403':
          description: >-
            Un compte humain avec accès à la gestion de la facturation est
            requis ; les clés API sont rejetées.
        '422':
          description: Le fournisseur ne prend pas en charge un portail en libre-service.
        '502':
          description: Le fournisseur n'a pas pu initialiser le client ou le portail.
        '503':
          description: >-
            Le compte de facturation ou les autorisations n'ont pas pu être
            vérifiés.
      security:
        - BearerAuth: []
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clé API pour l'authentification machine-à-machine
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT pour les opérations initiées par l'utilisateur

````

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