PayZu GatewayApoio

Paginação


Nesta páginaPor rotaCursorFiltros

Percorra as listas da API até o último item, usando o cursor que cada página retorna.

Todas as listas vão do item mais novo para o mais antigo, e a resposta não traz total.

CampoOnde vaiRegra
limitQueryDe 1 a 100. Sem ele, a página traz até 100 itens.
cursorQueryO next_cursor da página anterior.
itemsRespostaOs itens da página.
next_cursorRespostaO cursor da página seguinte.

Um limit fora da faixa retorna 400 de validação, com limit em fields.

Por rota

RotaFiltros
GET /v1/plansstatus, recurrence, search, created_from e created_to
GET /v1/subscriptionsstatus, plan_id, customer_id, search, next_from, next_to, created_from e created_to
GET /v1/invoicesstatus, payment_method, customer_id, subscription_id, payment_link_id, external_reference, search, due_from, due_to, paid_from, paid_to, created_from, created_to e updated_from
GET /v1/customerssearch, subscription_status, plan_id, created_from e created_to
GET /v1/customers/:customer_id/cardscreated_from e created_to
GET /v1/chargebacksstatus, invoice_id, created_from e created_to
GET /v1/webhooksstatus, created_from e created_to
GET /v1/webhook-deliverieswebhook_id, status, event_type, created_from e created_to

Cursor

Passe o next_cursor da página anterior em cursor, como veio, e repita os mesmos filtros: o cursor guarda só a posição na lista. Na última página, next_cursor vem null, mesmo quando ela vem cheia. Um cursor que a API não gerou retorna 400 de validação, com cursor em fields.

bash
curl "https://api.sandbox.payzu.dev/v1/invoices?paid_from=2026-11-11&paid_to=2026-11-11&limit=2&cursor=WyIyMDI2LTExLTExVDE1OjI0OjEwLjUxMloiLCJpbl8zUnRZOG1LY1ZiNU53WHoyUWRMaDdFIl0" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Cada item da lista de faturas vem completo, igual à consulta, como em Consultar faturas.

Filtros

  • Os filtros de dia (created_from, created_to, due_from, due_to, paid_from, paid_to, next_from, next_to e updated_from) usam o formato AAAA-MM-DD, no fuso de São Paulo, e o dia informado entra inteiro na busca.
  • Cada filtro leva um valor só.
  • Os filtros se somam: a lista traz só o que atende a todos.
  • Parâmetro que a lista não tem é ignorado. Valor inválido num parâmetro que ela tem retorna 400 de validação, com o parâmetro em fields.
  • Num filtro, um id que não existe na sua conta retorna a lista vazia. Na lista de cartões, um cliente que não existe no caminho retorna 404.

O cursor segue a data de criação.

Um item criado depois da primeira página não aparece nas páginas seguintes. Para vê-lo, comece de novo, sem cursor.