Listar cobranças
Consulte as cobranças da sua conta com filtros e paginação por cursor.
Consulta as cobranças da empresa e do ambiente da sua chave de API. Você pode filtrar pelo identificador da cobrança, referência externa, cliente, e-mail registrado na cobrança, status, meio de pagamento ou período de criação, vencimento e pagamento. O filtro usa o meio atual da cobrança; apenas selecionar uma opção no checkout não muda esse valor. Alterações de status ou referência externa podem levar alguns segundos para aparecer nos resultados filtrados.
Comece sem cursor, processe list e, enquanto page.has_next for true,
copie page.next_after para after, mantendo os filtros e a ordenação.
Copie o cursor inteiro, sem interpretar ou calcular seu conteúdo. Consulte
Listagem e paginação para voltar com before.
Veja como os filtros e a ordenação funcionam em
Listar cobranças.
O significado de external_reference está em
Referência no seu sistema.
Parâmetros de consulta
Quantidade de cobranças por página. Inteiros positivos acima do máximo usam o máximo. Valor omitido, vazio, zero, negativo ou inválido usa 10.
De 1 a 100
Copie page.next_after da resposta anterior para avançar. Mantenha os mesmos filtros e a ordenação; não envie before junto. Deixe vazio para começar a listagem.
Até 128 caracteres
Copie page.previous_before da resposta anterior para voltar. Mantenha os mesmos filtros e a ordenação; não envie after junto. Deixe vazio se não quiser voltar.
Até 128 caracteres
Filtra pelo ID completo da cobrança. Se não houver correspondência, list será vazio.
Até 100 caracteres
Filtra pelo ID público completo do cliente, retornado no cadastro ou na consulta. O vínculo permanece o mesmo se nome ou e-mail mudar. Pode ser combinado com os demais filtros; mantenha o mesmo customer_id ao mudar de página. Um ID válido sem cobranças na empresa e no ambiente da chave retorna list vazio. Vazio ou ausência não aplica o filtro.
Até 100 caracteres
Filtra pela referência atual da cobrança no seu sistema, com igualdade do valor completo, incluindo maiúsculas, minúsculas e acentos. Vazio ou ausência não aplica o filtro. Pode ser combinado com os demais filtros; preserve o valor ao navegar por cursor. Após criar ou editar uma cobrança, pode levar alguns segundos para a busca refletir a referência.
Até 120 caracteres
Filtra pelo e-mail completo registrado na cobrança. Alterar o cadastro do cliente não altera esse e-mail.
Até 254 caracteres
Filtra por um ou mais códigos separados por vírgula, como 0,1. 0 criado, 1 aguardando pagamento, 2 autorizado, 3 em processamento, 4 pago, 5 parcialmente devolvido, 6 devolvido, 7 cancelado, 8 expirado, 9 falha, 10 chargeback, 11 chargeback em análise, 12 chargeback perdido e 13 chargeback ganho. Pode levar alguns segundos para refletir alterações.
Até 64 caracteres
Filtra pelo meio de pagamento da cobrança: 1 para Pix e 2 para boleto. Para combinar, envie 1,2. Uma cobrança com meio indefinido pode passar a usar Pix ou boleto quando o código Pix ou boleto é gerado no checkout. A seleção na tela, por si só, não altera o filtro.
Até 32 caracteres
Filtra cobranças criadas a partir deste instante, inclusive, em segundos Unix UTC. Se informar created_lte, este valor deve ser menor ou igual a ele.
De 0 a 253402300799
Filtra cobranças criadas até este instante, inclusive, em segundos Unix UTC.
De 0 a 253402300799
Filtra cobranças com vencimento a partir deste instante, inclusive, em segundos Unix UTC. Pode ser combinado com due_lte e os demais filtros; mantenha o valor ao mudar de página.
De 0 a 253402300799
Filtra cobranças com vencimento até este instante, inclusive, em segundos Unix UTC. Se informar due_gte, este valor deve ser maior ou igual a ele. Pode ser usado sozinho ou com os demais filtros.
De 0 a 253402300799
Filtra cobranças pagas a partir deste instante, inclusive, em segundos Unix UTC. Usa a data do pagamento confirmado, mesmo quando houver estorno posterior. Cobranças sem pagamento confirmado ficam fora do resultado. Mantenha o valor ao mudar de página.
De 0 a 253402300799
Filtra cobranças pagas até este instante, inclusive, em segundos Unix UTC. Se informar paid_gte, este valor deve ser maior ou igual a ele. Pode ser combinado com os demais filtros.
De 0 a 253402300799
Ordena por valor em centavos ou data de criação. Se omitido, usa a ordem de cadastro; com filtro de criação, usa created_at. Mantenha a mesma ordenação ao mudar de página.
Define a direção da ordenação. Com desc, a ordem padrão mostra as cobranças mais recentes primeiro.
Respostas
Para os erros gerais, consulte Códigos HTTP das respostas.