Consulta de cobranças
Filtros, paginação e sincronização com GET /payments.
GET /payments lista as cobranças do lojista do token, com filtros, paginação e ordenação. Exige o escopo
pagamentos:read.
curl -s "https://api.u2dpay.com.br/payments?status=PENDING&status=OVERDUE&size=50" \
-H "Authorization: Bearer $ACCESS_TOKEN"Filtros
Todos são opcionais e se combinam (E lógico).
| Parâmetro | Exemplo | Semântica |
|---|---|---|
status | status=PENDING&status=OVERDUE | Um ou mais status (repita o parâmetro) |
billingType | billingType=PIX | Uma ou mais formas de pagamento |
payerDocument | payerDocument=12345678909 | CPF (11) ou CNPJ (14) do pagador, só dígitos |
dueDateFrom / dueDateTo | 2030-01-01 | Vencimento, intervalo fechado |
paidOnFrom / paidOnTo | 2030-01-01 | Data do pagamento (horário de Brasília), intervalo fechado |
createdFrom / createdTo | 2030-01-01T00:00:00Z | Criação: createdFrom incluído, createdTo excluído |
Paginação e ordenação
pagecomeça em 0 (padrão 0);sizevai de 1 a 100 (padrão 20).sortaceitacreatedAt(padrão),dueDate,paidOnouamount, com,ascou,desc(padrãodesc). Exemplo:sort=dueDate,asc.- A ordem é estável entre páginas. Cobranças sem
paidOnficam no fim ao ordenar por ele.
{
"content": [ { "id": "0b6f7c1e-...", "status": "PENDING", "amount": 49.90 } ],
"page": { "number": 0, "size": 50, "totalElements": 132, "totalPages": 3 }
}Nenhum resultado responde 200 com content: [].
Sincronizando por janelas
Para manter seu sistema em dia sem perder nem repetir cobranças, consulte em janelas consecutivas de
criação. O createdTo de uma janela é o createdFrom da seguinte; como o createdTo é exclusivo, a
cobrança da borda aparece uma vez só.
GET /payments?createdFrom=2030-01-14T12:00:00Z&createdTo=2030-01-14T13:00:00Z&size=100
GET /payments?createdFrom=2030-01-14T13:00:00Z&createdTo=2030-01-14T14:00:00Z&size=100Erros
sizeoupagefora do limite,sortfora da lista oupayerDocumentsem 11 ou 14 dígitos →400.- Intervalo invertido (
Fromdepois doTo) →400. - Valor em formato inválido (
status=FOO, data fora do ISO-8601) →400com a mensagem "valor em formato inválido".
