Paginação
Percorra as listas da API até o último item, usando o controle de página que cada rota retorna.
Por rota
| Rota | Página | Itens por página | Próxima página |
|---|---|---|---|
| GET /user/transactions | page | limit de 1 a 1.000, padrão 10 | total e pages |
| GET /user/report | page | limit até 100, padrão 10 | total e pages |
| GET /user/bank-statements | page | limit até 100, padrão 10 | pagination.hasNextPage |
| GET /user/callbacks | page | limit até 100, padrão 10 | pagination.hasNextPage |
| GET /user/infractions | page | limit até 100, padrão 10 | pagination.totalItems e pagination.totalPages |
| GET /user/deposit-pending | page | limit até 100, padrão 20 | hasNextPage |
| GET /user/whitelist/cnpj e GET /user/whitelist/pix-key | cursor | limit de 1 a 100, padrão 20 | pageInfo.hasNextPage e pageInfo.nextCursor |
page começa em 1. Um limit fora da faixa retorna 400, exceto em depósitos via chave, em que a API usa 20 no lugar do valor recusado e 1 no lugar de uma página inválida.
Contagem total
Em transações e infrações, a contagem para em 100.000: acima disso, total e totalItems mostram 100.000. Em transações, total e pages podem levar até 1 minuto para incluir as transações mais novas. Para não perder itens, avance até uma página vir com menos itens que o limit.
Cursor
Nas listas de permissão, passe pageInfo.nextCursor em cursor para pedir a próxima página. Na última, hasNextPage vem false e nextCursor não vem.
Use o mesmo filtro e a mesma ordenação em todas as páginas de uma consulta.
Para levar um período inteiro de transações para um arquivo, peça o Relatório em CSV em vez de percorrer as páginas.