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

> Crie um link de portal Stripe de curta duração para uma conta de faturamento logada.

Use esta ação em **Console → Configurações → Cobrança → Métodos de pagamento** ou seu
página de faturamento do consumidor. Requer uma sessão humana autenticada. Chaves de API não podem abrir
um portal do cliente. Espaços de trabalho empresariais exigem um administrador de espaço de trabalho ativo
ou uma função em todo o locatário com permissão de gerenciamento de faturamento.

Para um espaço de trabalho baseado em uso sem um cliente Stripe vinculado, o portal explícito
solicitação inicializa e vincula esse cliente usando o e-mail da conta verificada.
Abrir o portal não cobra um cartão, não cria uma subscrição, nem altera o plano.

## Solicitação

Defina `provider` como `stripe` (o padrão). O Flutterwave atualmente não fornece um
portal de autoatendimento através deste endpoint. Paystack não é suportado aqui.

Defina `return_url` para um endereço HTTPS em `console.truthlocks.com` para uma empresa
sessão ou `verify.truthlocks.com` para uma sessão de consumidor. Outros hosts são rejeitados.

## Resposta

`portal_url` é um link Stripe de curta duração. Abra-o para adicionar ou atualizar detalhes de pagamento
e visualize as faturas Stripe disponíveis. A configuração do portal de método de pagamento da Truthlocks
não permite alterações ou cancelamento de assinatura; use a página de faturamento apropriada
página para essas ações. Trate este link como privado e solicite um novo a cada vez.

## Erros

Erros retornam JSON com `code` e `error`. `403` significa que a pessoa logada não pode
gerenciar esta conta de faturamento. `422` identifica um provedor não suportado. `502` ou
`503` indica uma falha do provedor ou do serviço de conta; a mensagem explica o
próximo passo. Uma falha na pesquisa de conta não cria outro cliente provedor.


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/billing/portal
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

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


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  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 Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço 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 pagamento
      description: >-
        Requer uma conta humana conectada. Administradores de espaço de trabalho
        e gerentes de faturamento de todo o locatário podem inicializar um
        cliente Stripe vinculado e abrir seu portal de método de pagamento.
        Nenhum pagamento ou assinatura é criado por esta solicitação. Chaves de
        API não são aceitas.
      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 é o provedor de portal de autoatendimento suportado.
                return_url:
                  type: string
                  format: uri
                  example: https://console.truthlocks.com/settings/billing
                  description: >-
                    Endereço HTTPS em console.truthlocks.com para sessões de
                    negócios ou verify.truthlocks.com para sessões de
                    consumidor.
      responses:
        '200':
          description: >-
            Link de portal de método de pagamento de curta duração; não confirma
            um pagamento.
          content:
            application/json:
              schema:
                type: object
                required:
                  - portal_url
                properties:
                  portal_url:
                    type: string
                    format: uri
        '400':
          description: Requisição ou endereço de retorno inválido.
        '401':
          description: Login necessário.
        '403':
          description: >-
            É necessária uma conta humana com acesso à gestão de faturamento;
            chaves de API são rejeitadas.
        '422':
          description: O provedor não suporta um portal de autoatendimento.
        '502':
          description: O provedor não conseguiu inicializar o cliente ou o portal.
        '503':
          description: Conta de faturamento ou permissões não puderam ser verificadas.
      security:
        - BearerAuth: []
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

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