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

# Listar Cobranças Imediatas

> Use este endpoint para listar todas as cobranças imediatas de uma conta com filtros opcionais e paginação. Retorna um array vazio [] se nenhuma cobrança corresponder aos critérios.



## OpenAPI

````yaml pt/openapi/v3-current/indirect-pix.yaml GET /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:
    get:
      tags:
        - Collections API
      summary: Listar Cobranças Imediatas
      description: >-
        Use este endpoint para listar todas as cobranças imediatas de uma conta
        com filtros opcionais e paginação. Retorna um array vazio [] se nenhuma
        cobrança corresponder aos critérios.
      parameters:
        - name: X-Account-Id
          in: header
          description: ID da Conta (formato UUID)
          required: true
          schema:
            type: string
        - name: limit
          in: query
          description: Número máximo de cobranças por página (1-100)
          schema:
            type: integer
        - name: page
          in: query
          description: Número da página para paginação (começando em 1)
          schema:
            type: integer
        - name: status
          in: query
          description: Filtro de status
          schema:
            type: string
        - name: tags
          in: query
          description: Filtro de tags
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListImmediateCollectionsOutput'
        '400':
          description: Bad Request
          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:
    ListImmediateCollectionsOutput:
      properties:
        items:
          description: Items é o array de resultados de cobranças
          items:
            $ref: '#/components/schemas/ImmediateCollectionOutput'
          type: array
        limit:
          description: Limit é o número máximo de resultados retornados
          example: 10
          type: integer
        page:
          description: Page é o número da página atual
          example: 1
          type: integer
        total:
          description: Total é o número total de cobranças que correspondem aos filtros
          example: 150
          type: integer
      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.
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````