---
title: "List Boleto Payments"
method: GET
path: "/v1/boleto-payments"
tags: ["Boleto Payments"]
---

# List Boleto Payments

`GET /v1/boleto-payments`

Retrieves a paginated list of boleto payments for the authenticated account. Supports filtering by external_reference_id and cursor-based pagination for efficient data retrieval.

## Query parameters

- `external_reference_id` string, nullable
- `transaction_id` integer, nullable
- `limit` integer, nullable
- `cursor` string, nullable

## Response `200`

Boleto payments retrieved successfully

- GetBoletoPaymentsResponse
  - `next_cursor` string, nullable
  - `payments` BoletoPaymentItemResponse[], required
    - `amount_in_cents` integer, nullable
    - `barcode_line` string, required
    - `created_at` string, date-time, required — Payment creation timestamp (UTC, RFC 3339).
    - `description` string, nullable
    - `external_reference_id` string, nullable
    - `failed_message` string, nullable
    - `id` integer, required
    - `scheduled_date` string, date, nullable — Scheduled execution date (`YYYY-MM-DD`). Null when executed immediately.
    - `status` 'awaiting_approval' | 'pending' | 'processing' | 'success' | 'cancelled' | 'failed', required
    - `tax_id` string, required
    - `transaction_id` integer, nullable

## Other responses

- `400` — Invalid query parameters. Error code: INVALID_REQUEST (invalid cursor format or limit out of range 1–100)
- `401` — Authentication failed
- `403` — Access denied - requires ViewTransactions permission
- `500` — Internal server error

---

[API](https://skmtc.net/kiwify/apis/conta-digital-api.md) · [All operations](https://skmtc.net/kiwify/apis/conta-digital-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kiwify/conta-digital-api/versions/5e009b25c245/schema)