v1

latestOpenAPI 3.1.02026-08-0629140119.9 KB

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

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"
    }
  ]
}