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

# Gerar cobrança PIX (Cash-In)

> **Requer token Bearer no header Authorization**. Gera um QR Code dinâmico para recebimento via PIX.



## OpenAPI

````yaml post /api/pix/cash-in
openapi: 3.0.0
info:
  title: Fire Banking Public API
  description: >-
    API Pública da Plataforma Fire Banking para integração com serviços de
    pagamento PIX e gestão de contas
  version: 0.1.0
  contact: {}
servers:
  - url: https://api.public.firebanking.com.br
    description: Servidor de produção
security: []
tags:
  - name: auth
    description: Endpoints de autenticação
  - name: Balance
    description: Endpoints de consulta de saldo
  - name: PIX
    description: Endpoints de transações PIX
  - name: Webhooks
    description: Endpoints de gerenciamento de webhooks
paths:
  /api/pix/cash-in:
    post:
      tags:
        - PIX
      summary: Gerar cobrança PIX (Cash-In)
      description: >-
        **Requer token Bearer no header Authorization**. Gera um QR Code
        dinâmico para recebimento via PIX.
      operationId: PixController_cashIn
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CashInInputDto'
      responses:
        '201':
          description: Cobrança PIX gerada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashInOutputDto'
        '400':
          description: Dados inválidos
        '401':
          description: Token não fornecido ou inválido
        '500':
          description: Erro ao gerar cobrança PIX
      security:
        - bearer: []
components:
  schemas:
    CashInInputDto:
      type: object
      required:
        - transaction
        - payer
      properties:
        transaction:
          description: Dados da transação
          allOf:
            - $ref: '#/components/schemas/TransactionDtoClass'
        payer:
          description: Dados do pagador
          allOf:
            - $ref: '#/components/schemas/PayerDtoClass'
        additionalInfo:
          type: object
          description: >-
            Informações adicionais (objeto chave-valor string:string, máximo 10
            chaves)
          example:
            key1: value1
            orderId: ORD-12345
    CashInOutputDto:
      type: object
      required:
        - transactionId
        - correlationId
        - externalId
        - status
        - pixCode
        - generateTime
        - expirationDate
      properties:
        transactionId:
          type: string
          description: Identificador único da transação gerada
          example: '123'
        correlationId:
          type: string
          description: ID de correlação da transação (UUID)
          example: 550e8400-e29b-41d4-a716-446655440000
        externalId:
          type: string
          description: ID externo da transação (mesmo valor do input)
          example: external-teste-01
        status:
          type: string
          description: Status da transação
          enum:
            - PENDING
            - CONFIRMED
            - ERROR
          example: PENDING
        pixCode:
          type: string
          description: Código Pix no formato padrão EMV
          example: 00020126580014br.gov.bcb.pix...
        generateTime:
          type: string
          description: Data e hora de geração do Pix (formato ISO 8601)
          example: '2024-01-15T10:30:00.000Z'
        expirationDate:
          type: string
          description: Data e hora de expiração do Pix (formato ISO 8601)
          example: '2024-01-16T10:30:00.000Z'
        qrCodeImage:
          type: string
          description: QR Code em Base64 (apenas quando generateQrCode=true)
          example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...
    TransactionDtoClass:
      type: object
      required:
        - value
        - description
        - externalId
      properties:
        value:
          type: number
          description: Valor da transação em reais (decimal com até 2 casas decimais)
          example: 0.05
        description:
          type: string
          description: Descrição da transação
          example: Cobrança de teste
        expirationTime:
          type: number
          description: Tempo de expiração em segundos (mínimo 5 minutos, máximo 7 dias)
          example: 86400
          default: 86400
        externalId:
          type: string
          description: ID externo da transação (identificador único)
          example: external-teste-01
        generateQrCode:
          type: boolean
          description: Se verdadeiro, retorna o QR Code em Base64 e o código Pix
          example: true
          default: false
    PayerDtoClass:
      type: object
      required:
        - fullName
        - document
      properties:
        fullName:
          type: string
          description: Nome completo do pagador
          example: John Marvin
        document:
          type: string
          description: CPF ou CNPJ do pagador (apenas números)
          example: '12312312387'
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Enter JWT token

````