Boleto Payments

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

get/v1/boleto-payments

Request

Base URL
https://conta-public-api.kiwify.com
URL
https://conta-public-api.kiwify.com/v1/boleto-payments
Auth
API key in header x-access-id and API key in header X-PoP-Challenge and API key in header X-PoP-Format and API key in header X-PoP-Signature

Query parameters

external_reference_idstring nullable

Filter by external reference ID (exact match)

transaction_idinteger nullable

Filter by transaction ID (exact match)

limitinteger nullable

Maximum number of results per page (1–100, default: 20).

cursorstring nullable

Pagination cursor in format "timestamp_micros:id"

Response

Boleto payments retrieved successfully

next_cursorstring nullable

Example response

{
  "payments": [
    {
      "created_at": "2026-05-28T14:30:00Z",
      "scheduled_date": "2026-06-01"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.