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

# Listar boletos pagos

> Obtém pagamentos de boleto **iniciados via API apenas**. Pagamentos feitos pelo app web ou mobile não são incluídos.



## OpenAPI

````yaml /api-reference/banking/openapi.pt.json get /v1/boleto-payments
openapi: 3.1.0
info:
  title: API Conta Digital
  description: API pública para gerenciamento de conta, extrato e operações PIX
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://conta-public-api.kiwify.com
    description: Production environment
security: []
tags:
  - name: Conta
    description: Detalhes da conta, saldo, limites e chaves PIX
  - name: Extrato
    description: Extrato e histórico de transações
  - name: Enviar Pix
    description: Enviar dinheiro via transferências PIX
  - name: Receber Pix
    description: Reembolsar transações PIX
  - name: Pagar boletos
    description: Pagar boletos via API
  - name: QR Codes PIX
    description: Geração de QR codes PIX para receber pagamentos
  - name: Webhooks
    description: >-
      Gerenciamento de assinaturas de webhook para recebimento de notificações
      de eventos
paths:
  /v1/boleto-payments:
    get:
      tags:
        - Pagar boletos
      summary: Listar boletos pagos
      description: >-
        Obtém pagamentos de boleto **iniciados via API apenas**. Pagamentos
        feitos pelo app web ou mobile não são incluídos.
      operationId: get_boleto_payments
      parameters:
        - name: external_reference_id
          in: query
          description: Filter by external reference ID (exact match)
          required: false
          schema:
            type:
              - string
              - 'null'
        - name: transaction_id
          in: query
          description: Filter by transaction ID (exact match)
          required: false
          schema:
            type:
              - integer
              - 'null'
            format: int64
        - name: limit
          in: query
          description: 'Maximum number of results per page (1–100, default: 20).'
          required: false
          schema:
            type:
              - integer
              - 'null'
            format: int32
            minimum: 0
        - name: cursor
          in: query
          description: Pagination cursor in format "timestamp_micros:id"
          required: false
          schema:
            type:
              - string
              - 'null'
      responses:
        '200':
          description: Boleto payments retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBoletoPaymentsResponse'
        '400':
          description: >-
            Invalid query parameters. Error code: INVALID_REQUEST (invalid
            cursor format or limit out of range 1–100)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Access denied - requires ViewTransactions permission
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - AccessId: []
          PoPChallenge: []
          PoPFormat: []
          PoPSignature: []
components:
  schemas:
    GetBoletoPaymentsResponse:
      type: object
      required:
        - payments
      properties:
        next_cursor:
          type:
            - string
            - 'null'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/BoletoPaymentItemResponse'
    ErrorResponse:
      type: object
      required:
        - error
        - timestamp
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetails'
          description: Error payload.
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 / RFC 3339 UTC timestamp of when the error occurred.
          example: '2026-05-28T14:30:00Z'
    BoletoPaymentItemResponse:
      type: object
      required:
        - id
        - status
        - barcode_line
        - tax_id
        - created_at
      properties:
        amount_in_cents:
          type:
            - integer
            - 'null'
          format: int64
        barcode_line:
          type: string
        created_at:
          type: string
          format: date-time
          description: Payment creation timestamp (UTC, RFC 3339).
          example: '2026-05-28T14:30:00Z'
        description:
          type:
            - string
            - 'null'
        external_reference_id:
          type:
            - string
            - 'null'
        failed_message:
          type:
            - string
            - 'null'
        id:
          type: integer
          format: int64
        scheduled_date:
          type:
            - string
            - 'null'
          format: date
          description: >-
            Scheduled execution date (`YYYY-MM-DD`). Null when executed
            immediately.
          example: '2026-06-01'
        status:
          $ref: '#/components/schemas/BoletoPaymentItemStatusResponse'
        tax_id:
          type: string
        transaction_id:
          type:
            - integer
            - 'null'
          format: int64
    ErrorDetails:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: >-
            Machine-readable error code. Use this for branching logic, not
            `message`.
          example: INVALID_REQUEST
        details:
          type: object
          description: >-
            Optional structured details. For `INVALID_REQUEST`, may be an array
            of field validation errors or a `validation_failed` object depending
            on the endpoint.
        message:
          type: string
          description: >-
            Human-readable error description. Do not rely on this text for
            programmatic handling.
    BoletoPaymentItemStatusResponse:
      type: string
      enum:
        - awaiting_approval
        - pending
        - processing
        - success
        - cancelled
        - failed
  securitySchemes:
    AccessId:
      type: apiKey
      in: header
      name: x-access-id
      description: UUID of the service account (e.g., 550e8400-e29b-41d4-a716-446655440000)
    PoPChallenge:
      type: apiKey
      in: header
      name: X-PoP-Challenge
      description: >-
        Unix timestamp in milliseconds (e.g., 1704636800000). Must be within 5
        minutes of server time.
    PoPFormat:
      type: apiKey
      in: header
      name: X-PoP-Format
      description: Must be 'service-account' for service account authentication
    PoPSignature:
      type: apiKey
      in: header
      name: X-PoP-Signature
      description: >-
        EdDSA signature of the request in base64 format. Signs:
        uri:method:body:timestamp

````