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

# Criar uma Cobrança Imediata

> Use este endpoint para criar uma cobrança Pix imediata (cobrança imediata) com um QR Code dinâmico que expira após um período definido.

**Notas:**
- Cada cobrança imediata é única e pode ser paga apenas uma vez
- O valor e o tempo de expiração são obrigatórios
- O ID da transação (txId) deve ser único entre todas as cobranças
- O status muda automaticamente para CONCLUDED quando o pagamento é recebido
- A cobrança expira automaticamente após o período de tempo especificado



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml POST /v1/collections/immediate
openapi: 3.0.3
info:
  title: Plugin BR Pix Indireto - API Completa
  description: |
    API completa para o sistema brasileiro de pagamentos instantâneos Pix,
    incluindo operações de dicionário de chaves Pix, geração/decodificação de
    QR Code, transações e limites de transações.
  version: 1.0.0
servers:
  - url: https://plugin-pix-indirect.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/collections/immediate:
    post:
      tags:
        - Collections API
      summary: Criar uma Cobrança Imediata
      description: >-
        Use este endpoint para criar uma cobrança Pix imediata (cobrança
        imediata) com um QR Code dinâmico que expira após um período definido.


        **Notas:**

        - Cada cobrança imediata é única e pode ser paga apenas uma vez

        - O valor e o tempo de expiração são obrigatórios

        - O ID da transação (txId) deve ser único entre todas as cobranças

        - O status muda automaticamente para CONCLUDED quando o pagamento é
        recebido

        - A cobrança expira automaticamente após o período de tempo especificado
      parameters:
        - name: X-Account-Id
          in: header
          description: ID da Conta (formato UUID)
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImmediateCollectionInput'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImmediateCollectionOutput'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
      deprecated: false
      security:
        - bearerAuth: []
components:
  schemas:
    CreateImmediateCollectionInput:
      properties:
        additionalInfo:
          additionalProperties:
            type: string
          description: AdditionalInfo é um mapa de chave-valor para informações adicionais
          example:
            customerId: '67890'
            orderId: '12345'
          type: object
        amount:
          description: Amount é o valor da cobrança em formato decimal com 2 casas decimais
          example: '100.00'
          type: string
        debtorDocument:
          description: >-
            DebtorDocument é o CPF ou CNPJ do pagador (opcional, deve ser
            informado junto com DebtorName)
          example: '12345678901'
          type: string
        debtorName:
          description: >-
            DebtorName é o nome do pagador (opcional, deve ser informado junto
            com DebtorDocument)
          example: João da Silva
          type: string
        description:
          description: >-
            Description é uma mensagem ou descrição personalizada para a
            cobrança
          example: 'Payment for order #12345'
          type: string
        expirationSeconds:
          description: ExpirationSeconds é o tempo em segundos até a cobrança expirar
          example: 3600
          type: integer
        locationInformation:
          allOf:
            - $ref: '#/components/schemas/LocationInformationDTO'
          description: >-
            LocationInformation contém os dados de localização do
            estabelecimento para a geração do QR code
        metadata:
          additionalProperties: {}
          description: >-
            Metadata é um mapa opcional para pares de chave-valor personalizados
            (máx. 50 chaves)
          type: object
        receiverKey:
          description: Chave Pix que receberá o pagamento
          example: '+5511999999999'
          type: string
        tags:
          description: Tags é um array de tags personalizadas para categorização
          example:
            - ecommerce
            - subscription
          items:
            type: string
          type: array
        transactionAmount:
          description: Valor da compra para o Pix Troco
          example: '150.00'
          type: string
        txId:
          description: TxID é o identificador único da transação para esta cobrança
          example: TXabcdefghijklmno123456789
          type: string
        withdrawalAmount:
          description: Valor do saque para o Pix Saque ou Pix Troco
          example: '50.00'
          type: string
      required:
        - amount
        - expirationSeconds
        - receiverKey
        - txId
      type: object
    ImmediateCollectionOutput:
      properties:
        additionalInfo:
          additionalProperties:
            type: string
          description: AdditionalInfo contém informações adicionais de chave-valor
          example:
            customerId: '67890'
            orderId: '12345'
          type: object
        amount:
          description: Amount é o valor da cobrança em formato decimal
          example: '100.00'
          type: string
        createdAt:
          description: CreatedAt é o timestamp de quando a cobrança foi criada
          example: '2024-01-15T10:30:00Z'
          type: string
        debtorDocument:
          description: DebtorDocument é o CPF ou CNPJ do pagador
          example: '12345678901'
          type: string
        debtorName:
          description: DebtorName é o nome do pagador
          example: João da Silva
          type: string
        description:
          description: Description é a descrição personalizada da cobrança
          example: 'Payment for order #12345'
          type: string
        emv:
          description: EMV é o payload do QR code no formato EMV
          example: 00020126580014br.gov.bcb.pix...
          type: string
        expirationSeconds:
          description: ExpirationSeconds é o tempo em segundos até a expiração
          example: 3600
          type: integer
        id:
          description: ID é o identificador único da cobrança
          example: 550e8400-e29b-41d4-a716-446655440000
          type: string
        locationUrl:
          description: LocationURL é a URL para acessar a localização/QR code da cobrança
          example: https://api.example.com/qr/550e8400
          type: string
        metadata:
          additionalProperties: {}
          description: Metadata são os metadados personalizados associados a esta cobrança
          type: object
        receiverKey:
          description: Chave Pix que receberá o pagamento
          example: '+5511999999999'
          type: string
        status:
          description: Status é o status atual da cobrança
          example: ACTIVE
          type: string
        tags:
          description: Tags é um array de tags personalizadas
          example:
            - ecommerce
            - subscription
          items:
            type: string
          type: array
        txId:
          description: TxID é o identificador da transação
          example: TXN123456789
          type: string
        updatedAt:
          description: UpdatedAt é o timestamp da última atualização
          example: '2024-01-15T10:30:00Z'
          type: string
      type: object
    ErrorFormat:
      type: object
      description: A mensagem de erro da resposta.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Um identificador único e estável para o erro.
        title:
          type: string
          description: Um breve resumo do problema.
        message:
          type: string
          description: Orientação detalhada para resolver o erro.
    LocationInformationDTO:
      properties:
        categoryCode:
          description: CategoryCode é o código de categoria do estabelecimento (MCC)
          example: '5411'
          type: string
        merchantCity:
          description: MerchantCity é a cidade onde o estabelecimento está localizado
          example: São Paulo
          type: string
        merchantName:
          description: MerchantName é o nome do estabelecimento
          example: Loja ABC
          type: string
        postalCode:
          description: PostalCode é o CEP do estabelecimento
          example: 01310-100
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````