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

# Abrir portal de método de pago

> Cree un enlace de portal de Stripe de corta duración para una cuenta de facturación iniciada.

Utilice esta acción desde **Console → Configuración → Facturación → Métodos de pago** o su
página de facturación del consumidor. Requiere una sesión humana iniciada. Las claves API no pueden abrir
un portal de clientes. Los espacios de trabajo empresariales requieren un administrador de espacio de trabajo activo
o un rol a nivel de inquilino con permiso de gestión de facturación.

Para un espacio de trabajo basado en el uso sin un cliente de Stripe vinculado, el portal explícito
la solicitud inicializa y vincula a ese cliente utilizando el correo electrónico de la cuenta verificada.
Abrir el portal no carga una tarjeta, no crea una suscripción ni cambia el plan.

## Solicitud

Establezca `provider` en `stripe` (el valor predeterminado). Flutterwave no proporciona actualmente un
portal de autoservicio a través de este endpoint. Paystack no es compatible aquí.

Establezca `return_url` en una dirección HTTPS en `console.truthlocks.com` para una empresa
sesión o `verify.truthlocks.com` para una sesión de consumidor. Otros hosts son rechazados.

## Respuesta

`portal_url` es un enlace de Stripe de corta duración. Ábralo para agregar o actualizar los detalles de pago
y ver las facturas de Stripe disponibles. La configuración del portal de métodos de pago de Truthlocks
no permite cambios o cancelaciones de suscripción; use la página de facturación apropiada
página para esas acciones. Trate este enlace como privado y solicite uno nuevo cada vez.

## Errores

Los errores devuelven JSON con `code` y `error`. `403` significa que la persona que ha iniciado sesión no puede
administrar esta cuenta de facturación. `422` identifica un proveedor no compatible. `502` o
`503` indica una falla del proveedor o del servicio de cuenta; el mensaje explica el
siguiente paso. Una búsqueda de cuenta fallida no crea otro cliente proveedor.


## OpenAPI

````yaml es/mint-openapi.yaml POST /v1/billing/portal
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks es una infraestructura de verificación universal para documentos,
    credenciales y activos digitales.

    Esta especificación define la API canónica para interactuar con los
    servicios de Truthlocks.


    ## URLs Base

    - **Producción**: `https://api.truthlocks.com`

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


    ## Autenticación

    - **Claves API**: Use el encabezado `X-API-Key` para operaciones máquina a
    máquina

    - **Tokens Bearer**: Use `Authorization: Bearer <jwt>` para operaciones
    iniciadas por el usuario


    ## Identidad del Inquilino

    En producción, la identidad del inquilino se deriva del contexto autenticado
    (clave API o JWT).

    El encabezado `X-Tenant-ID` se ignora en producción para evitar la
    suplantación de identidad.
  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 producción
  - url: https://sandbox-api.truthlocks.com
    description: Entorno Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestión de claves y tokens de API
  - name: Issuers
    description: Registro del emisor y gestión de la confianza
  - name: Keys
    description: Gestión de claves criptográficas para emisores
  - name: Attestations
    description: Ciclo de vida de la atestación (acuñar, revocar, reemplazar)
  - name: Verification
    description: Verificación de atestación y paquetes de prueba
  - name: Governance
    description: Flujos de trabajo de gobernanza del emisor (solo administrador)
  - name: Identity
    description: Gestión de organización, usuarios y roles
  - name: Audit
    description: Consultas de eventos de auditoría
  - name: Tenant Console
    description: Puntos finales de perfil y ciclo de vida del inquilino
  - name: Health
    description: Endpoints de estado y preparación del servicio
  - name: Risk
    description: Ingesta de señales de riesgo y detección de fraude
  - name: Risk Enforcement
    description: >-
      Acciones de aplicación de riesgos: bloqueo, desafío, cuarentena y
      configuración
  - name: Billing
    description: Gestión de facturación, suscripciones y complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidad de Agente de Máquina (MAIP) — registro de agentes,
      sesiones, confianza, testigo, cumplimiento, orquestación y observabilidad
externalDocs:
  description: API de transparencia de solo lectura (especificación de servicio separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/portal:
    post:
      tags:
        - Billing
      summary: Abrir portal de método de pago
      description: >-
        Requiere una cuenta humana con sesión iniciada. Los administradores del
        espacio de trabajo y los gerentes de facturación de todo el inquilino
        pueden inicializar un cliente de Stripe vinculado y abrir su portal de
        métodos de pago. Esta solicitud no crea ningún pago ni suscripción. Las
        claves API no son aceptadas.
      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 es el proveedor de portal de autoservicio compatible.
                return_url:
                  type: string
                  format: uri
                  example: https://console.truthlocks.com/settings/billing
                  description: >-
                    Dirección HTTPS en console.truthlocks.com para sesiones de
                    negocios o verify.truthlocks.com para sesiones de
                    consumidores.
      responses:
        '200':
          description: >-
            Enlace de portal de método de pago de corta duración; no confirma un
            pago.
          content:
            application/json:
              schema:
                type: object
                required:
                  - portal_url
                properties:
                  portal_url:
                    type: string
                    format: uri
        '400':
          description: Solicitud o dirección de retorno no válida.
        '401':
          description: Inicio de sesión requerido.
        '403':
          description: >-
            Se requiere una cuenta humana con acceso a la gestión de
            facturación; las claves API son rechazadas.
        '422':
          description: El proveedor no admite un portal de autoservicio.
        '502':
          description: El proveedor no pudo inicializar el cliente o el portal.
        '503':
          description: No se pudo verificar la cuenta de facturación o los permisos.
      security:
        - BearerAuth: []
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clave API para autenticación máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operaciones iniciadas por el usuario

````

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