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

# Iniciar o salvamento de cartão (Stripe Elements)

> Cria um SetupIntent do Stripe no cliente do workspace, para um formulário de cartão na sua própria página. Monte o Payment Element com o `clientSecret`, carregue o Stripe.js com o `publishableKey`, chame `stripe.confirmSetup()` e depois `POST /v1/billing/card/setup-intent/{id}/sync`. Sem corpo (qualquer campo → `400 UNKNOWN_FIELDS`). Só Proprietário (`billing:payment_method:manage`) com chave de conta ou token OAuth. Os dados do cartão vão do navegador de quem paga direto para o Stripe (Payment Element) e nunca chegam à Pilot Status. O `clientSecret` permite a quem o tiver confirmar o intent: não guarde em cache nem em log. Enviado com `Cache-Control: no-store`.

**Requer uma chave com escopo de tenant** — uma chave de workspace, ou uma chave de conta com `x-workspace-id`.

> [!WARNING]
>
> O `clientSecret` é para o Stripe.js na sua página. Veja [Checkout transparente](https://docs.pilotstatus.com.br/pt-BR/guides/transparent-checkout.md).


## OpenAPI

````yaml openapi.pt.json POST /v1/billing/card/setup-intent
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/billing/card/setup-intent:
    post:
      tags:
        - Billing
      summary: Iniciar o salvamento de cartão (Stripe Elements)
      description: >-
        Cria um SetupIntent do Stripe no cliente do workspace, para um
        formulário de cartão na sua própria página. Monte o Payment Element com
        o `clientSecret`, carregue o Stripe.js com o `publishableKey`, chame
        `stripe.confirmSetup()` e depois `POST
        /v1/billing/card/setup-intent/{id}/sync`. Sem corpo (qualquer campo →
        `400 UNKNOWN_FIELDS`). Só Proprietário (`billing:payment_method:manage`)
        com chave de conta ou token OAuth. Os dados do cartão vão do navegador
        de quem paga direto para o Stripe (Payment Element) e nunca chegam à
        Pilot Status. O `clientSecret` permite a quem o tiver confirmar o
        intent: não guarde em cache nem em log. Enviado com `Cache-Control:
        no-store`.


        **Requer uma chave com escopo de tenant** — uma chave de workspace, ou
        uma chave de conta com `x-workspace-id`.
      operationId: post_billing_card_setup_intent
      parameters:
        - name: x-workspace-id
          in: header
          required: false
          schema:
            type: string
          description: >-
            Só com chave de conta (`ps_account_`): o workspace em que agir,
            obtido em `GET /v1/workspaces`. Sem ele, uma chave de conta recebe
            `400 WORKSPACE_ID_REQUIRED`.
          example: cmh2a9z8y0002ws8example1q
      responses:
        '200':
          description: O intent
          content:
            application/json:
              example:
                clientSecret: seti_1QabcDEF_secret_xyz
                setupIntentId: seti_1QabcDEF
                publishableKey: pk_live_...
          headers:
            Cache-Control:
              schema:
                type: string
              example: no-store
        '400':
          description: '`INVALID_BODY` ou `UNKNOWN_FIELDS`'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Unknown field(s): customerId. Accepted: (none). | Campo(s)
                  desconhecido(s): customerId. Aceitos: (nenhum).
                code: UNKNOWN_FIELDS
        '401':
          description: Chave de API ausente, inválida ou revogada
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Invalid API key
        '403':
          description: >-
            Chave com escopo de número (`NUMBER_SCOPE_NOT_ALLOWED`), papel do
            usuário sem permissão (`PERMISSION_DENIED`) ou chave de conta fora
            dos seus workspaces (`WORKSPACE_MEMBERSHIP_REQUIRED`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: This endpoint requires a tenant-scoped API key
                code: NUMBER_SCOPE_NOT_ALLOWED
        '503':
          description: Pagamentos com cartão indisponíveis no momento
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: >-
                  Card payments are not available right now. | Pagamentos com
                  cartão não estão disponíveis no momento.
                code: PAYMENTS_NOT_CONFIGURED
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````

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