PayZu GatewayApoio
Paginação
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.
| Campo | Onde vai | Regra |
|---|---|---|
limit | Query | De 1 a 100. Sem ele, a página traz até 100 itens. |
cursor | Query | O next_cursor da página anterior. |
items | Resposta | Os itens da página. |
next_cursor | Resposta | O cursor da página seguinte. |
Um limit fora da faixa retorna 400 de validação, com limit em fields.
Por rota
| Rota | Filtros |
|---|---|
| GET /v1/plans | status, recurrence, search, created_from e created_to |
| GET /v1/subscriptions | status, plan_id, customer_id, search, next_from, next_to, created_from e created_to |
| GET /v1/invoices | status, 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/customers | search, subscription_status, plan_id, created_from e created_to |
| GET /v1/customers/:customer_id/cards | created_from e created_to |
| GET /v1/chargebacks | status, invoice_id, created_from e created_to |
| GET /v1/webhooks | status, created_from e created_to |
| GET /v1/webhook-deliveries | webhook_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"Trecho da resposta
{
"items": [
{
"id": "in_PSSHbv1eu5ZneriC2C3my4",
"status": "paid",
"created_at": "2026-11-11T15:20:59.361Z"
},
{
"id": "in_7Kd2QmXvB9LtYc4WnRz8Hs",
"status": "paid",
"created_at": "2026-11-11T15:20:59.333Z"
}
],
"next_cursor": null
}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_toeupdated_from) usam o formatoAAAA-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
400de validação, com o parâmetro emfields. - 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.