Atendimento

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âmetroExemploSemântica
statusstatus=PENDING&status=OVERDUEUm ou mais status (repita o parâmetro)
billingTypebillingType=PIXUma ou mais formas de pagamento
payerDocumentpayerDocument=12345678909CPF (11) ou CNPJ (14) do pagador, só dígitos
dueDateFrom / dueDateTo2030-01-01Vencimento, intervalo fechado
paidOnFrom / paidOnTo2030-01-01Data do pagamento (horário de Brasília), intervalo fechado
createdFrom / createdTo2030-01-01T00:00:00ZCriação: createdFrom incluído, createdTo excluído

Paginação e ordenação

  • page começa em 0 (padrão 0); size vai de 1 a 100 (padrão 20).
  • sort aceita createdAt (padrão), dueDate, paidOn ou amount, com ,asc ou ,desc (padrão desc). Exemplo: sort=dueDate,asc.
  • A ordem é estável entre páginas. Cobranças sem paidOn ficam 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=100

Erros

  • size ou page fora do limite, sort fora da lista ou payerDocument sem 11 ou 14 dígitos → 400.
  • Intervalo invertido (From depois do To) → 400.
  • Valor em formato inválido (status=FOO, data fora do ISO-8601) → 400 com a mensagem "valor em formato inválido".

Nesta página