Paginação

A API Pagar.me tem suporte à busca em massa através dos métodos list. Deste modo, você pode listar compradores, assinaturas, pedidos e diversos outros objetos do Pagar.me. Esses métodos de listagem podem ter um dos dois modelos de paginação disponíveis na API. Como cada endpoint utiliza um modelo específico, use o modelo correto para garantir resultados consistentes.

Modelos de paginação

Página

O modelo padrão da API. Você informa o número da página desejada e a quantidade de itens por página.

Query Params

Forward Cursor

O cursor é gerado e retornado no corpo do response. Diferente da paginação por página, você não controla o número da página, a API retorna um cursor que deve ser usado na próxima requisição para continuar de onde parou.

Exemplo de response com cursor

{
    "data": [
        {
            "id": 573310,
            "status": "paid",
            "amount": 1490,
            "fee": 18,
            "anticipation_fee": 0,
            "fraud_coverage_fee": 0,
            "recipient_id": "re_cixizke9v00dpqf6eo2gp520h",
            "payment_date": "2026-03-31T03:00:00Z",
            "type": "credit",
            "payment_method": "pix",
            "accrual_at": "2026-03-31T17:15:09Z",
            "created_at": "2026-03-31T17:15:09Z"
        }
    ],
    "paging": {
        "forward_cursor": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYWxhcGlDdXJzb3IiOiJleUpoYkdjaU9pSklVekkxTmlJc0luUjVjQ0k2SWtwWFZDSjkuZXlKcFlYUWlPaUl4TnpjNE56QTJOVFU0SWl3aVpYaHdJam94TnpjNE56RXdNVFU0TENKcFpDSTZJalF6TWpRMU16VTJNRGNpZlEuRGJyZ2VxZXhhd0lRbkZ3aUczV21kbHpfTjVHc3RaMUpRWThfb1dIQjhXOCIsImlhdCI6MTc3ODcwNjU1OCwiZXhwIjoxNzc4NzEwMTU4fQ.brlfaiQe3XD905nY9EVgdmjJazQdMSB1f3rl1RqZtvA"
    }
}

Você deve realizar a primeira requisição apenas com os filtros desejados e o size, sem enviar o forward_cursor no query params. A partir desse retorno, copie o valor de forward_cursor da resposta anterior e envie na próxima requisição, mantendo os mesmos filtros. Siga dessa forma sempre copiando o cursor da última requisição realizada até o forward_cursor retornar null, isso significa que todos os registros foram retornados e a iteração está concluída.

Não é possível retornar para a página anterior utilizando o cursor, apenas avançar para a próxima página.

Query Params