Pular para o conteúdo

Paginação

Coleções grandes (intenções de pagamento, faturas, transações, entregas de webhook, eventos) são paginadas com um cursor. As listas são ordenadas da mais recente para a mais antiga.

Parâmetro Padrão Descrição
limit 25 Tamanho da página, de 1 a 100
starting_after — O id do último objeto da página anterior
{
"object": "list",
"data": [{ "id": "pi_01J…", "object": "payment_intent" }],
"has_more": true,
"next_cursor": "pi_01J…"
}

Para buscar a próxima página, envie next_cursor como starting_after. Quando has_more é false, next_cursor é null. Os cursores continuam estáveis mesmo enquanto novos objetos estão sendo criados.

Coleções pequenas (lojas, carteiras, endpoints de webhook, links de pagamento) retornam { "object": "list", "data": [...] } sem paginação.

// Com await você recebe uma página; iterando, percorre todas as páginas sob demanda.
const firstPage = await gp.paymentIntents.list({ limit: 50 });
for await (const intent of gp.paymentIntents.list({ status: ['confirmed', 'overpaid'] })) {
console.log(intent.id);
}

GET /v1/payment-intents também aceita status (separado por vírgulas), store_id, search (busca no id, em merchant_order_id, no e-mail/referência do cliente e na descrição), created_gte, created_lt e source. Os filtros se combinam com a paginação.