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

# List Immediate Charges

> Use this endpoint to list all immediate collections for an account with optional filters and pagination. Returns empty array [] if no collections match the criteria.



## OpenAPI

````yaml /pt/openapi/v3-current/indirect-pix.yaml get /v1/collections/immediate
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: >-
    API for Pix Indirect via BTG. It covers DICT keys and claims; MED infraction
    reports, fraud markers, refund requests, and funds recoveries; DICT
    statistics and reconciliation; Pix transfers, refunds, and schedules; static
    QR codes and QR code decoding; immediate and due-date collections; Pix
    Automático for the payer; transaction reports and TemposTransacoes
    statistics; and inbound and outbound webhook records.
  license:
    name: Lerian Studio General License
  title: Pix BTG API
  version: 1.14.0
servers:
  - url: https://api.example.com
    description: >-
      Replace the example host with the URL provided during environment
      onboarding.
security:
  - BearerAuth: []
paths:
  /v1/collections/immediate:
    get:
      tags:
        - Immediate Collections
      summary: List Immediate Charges
      description: >-
        Use this endpoint to list all immediate collections for an account with
        optional filters and pagination. Returns empty array [] if no
        collections match the criteria.
      operationId: collection-list-immediate
      parameters:
        - description: Account ID (UUID format)
          in: header
          name: X-Account-Id
          required: true
          schema:
            description: Account ID (UUID format)
            format: uuid
            type: string
        - description: Maximum number of collections per page (1-100)
          explode: false
          in: query
          name: limit
          schema:
            default: 10
            description: Maximum number of collections per page (1-100)
            format: int64
            type: integer
        - description: Page number for pagination (starting at 1)
          explode: false
          in: query
          name: page
          schema:
            default: 1
            description: Page number for pagination (starting at 1)
            format: int64
            type: integer
        - description: 'Status filter. Allowed values: ACTIVE, COMPLETED, EXPIRED, DELETED'
          explode: false
          in: query
          name: status
          schema:
            description: 'Status filter. Allowed values: ACTIVE, COMPLETED, EXPIRED, DELETED'
            items:
              type: string
            type: array
        - description: Tags filter
          explode: false
          in: query
          name: tags
          schema:
            description: Tags filter
            items:
              type: string
            type: array
        - description: Metadata key to filter by
          explode: false
          in: query
          name: metadata.key
          schema:
            description: Metadata key to filter by
            type: string
        - description: Metadata value to filter by (requires metadata.key)
          explode: false
          in: query
          name: metadata.value
          schema:
            description: Metadata value to filter by (requires metadata.key)
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListImmediateCollectionsOutput'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Internal Server Error
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LegacyErrorBody'
          description: Error
components:
  schemas:
    ListImmediateCollectionsOutput:
      additionalProperties: false
      properties:
        items:
          items:
            $ref: '#/components/schemas/ImmediateCollectionOutput'
          type: array
        limit:
          examples:
            - 10
          format: int64
          type: integer
        page:
          examples:
            - 1
          format: int64
          type: integer
        total:
          examples:
            - 150
          format: int64
          type: integer
      required:
        - items
        - limit
        - page
        - total
      type: object
    LegacyErrorBody:
      additionalProperties: false
      properties:
        code:
          type: string
        fields:
          additionalProperties:
            type: string
          type: object
        headers:
          additionalProperties:
            type: string
          type: object
        message:
          type: string
        paths:
          additionalProperties:
            type: string
          type: object
        queryParams:
          additionalProperties:
            type: string
          type: object
        raw:
          type: string
        title:
          type: string
      required:
        - code
        - title
        - message
      type: object
    ImmediateCollectionOutput:
      additionalProperties: false
      properties:
        additionalInfo:
          additionalProperties:
            type: string
          examples:
            - customerId: '67890'
              orderId: '12345'
          type: object
        amount:
          examples:
            - '100.00'
          type: string
        createdAt:
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        debtorDocument:
          examples:
            - '52998224725'
          type: string
        debtorName:
          examples:
            - João da Silva
          type: string
        description:
          examples:
            - 'Payment for order #12345'
          type: string
        emv:
          examples:
            - 00020126580014br.gov.bcb.pix...
          type: string
        expirationSeconds:
          examples:
            - 3600
          format: int64
          type: integer
        id:
          examples:
            - 550e8400-e29b-41d4-a716-446655440000
          type: string
        locationUrl:
          examples:
            - https://api.example.com/qr/550e8400
          type: string
        metadata:
          additionalProperties: {}
          type: object
        receiverKey:
          examples:
            - '+5511999999999'
          type: string
        status:
          examples:
            - ACTIVE
          type: string
        tags:
          examples:
            - - ecommerce
              - subscription
          items:
            type: string
          type: array
        txId:
          examples:
            - TXN123456789
          type: string
        updatedAt:
          examples:
            - '2024-01-15T10:30:00Z'
          format: date-time
          type: string
      required:
        - id
        - txId
        - status
        - amount
        - receiverKey
        - expirationSeconds
        - createdAt
        - updatedAt
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````

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