PayZu CellOperações

Acompanhar as cobranças do mês


Nesta páginaListe as cobranças em abertoPercorra as páginas do mêsConfira os pagamentos de uma cobrançaSituação da cobrançaErros

Saiba quais cobranças das linhas dos seus clientes estão em aberto, quais já foram pagas e como cada uma foi paga.

Liste as cobranças em aberto

Filtre por status=PENDING. Para ver só uma linha ou um titular, acrescente lineId ou customerId.

bash
curl "https://api.payzucell.com.br/v1/charges?status=PENDING&limit=100" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"
  • amount: o valor da cobrança, em reais.
  • dueOn: o dia de vencimento.
  • expiresAt: o prazo para pagar.

Referência: Listar as cobranças

Percorra as páginas do mês

A lista não tem filtro de data. Para ler as cobranças criadas em um mês:

  • Ordem: a lista vem da cobrança mais nova para a mais antiga, pela data de criação, createdAt.
  • Situações: liste sem status, para vir todas.
  • Páginas: siga o nextCursor de cada página, sempre com os mesmos filtros da primeira chamada.
  • Fim do mês: ignore as cobranças criadas depois dele.
  • Começo do mês: pare na primeira cobrança com createdAt anterior a ele, ou quando nextCursor vier null.
  • Fuso: o createdAt vem em UTC. O mês no horário de Brasília começa às 03:00Z do dia 1.
bash
curl "https://api.payzucell.com.br/v1/charges?limit=100&cursor=WyIyMDI2LTExLTAzVDA5OjAwOjQxLjAwMFoiLCJjbTQ5dDJ3NmswMDAzcThmMmI4aDFyNXhlIl0" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

A cobrança que vence num mês pode ter sido criada no mês anterior.

A cobrança de renovação é criada antes do vencimento. Para separar pelo vencimento, dueOn, não pare pelo createdAt: siga as páginas até o nextCursor vir null.

O cursor e o limite por página estão em Paginação.

Confira os pagamentos de uma cobrança

bash
curl https://api.payzucell.com.br/v1/charges/cm4a6r2e80007q8f2v3b5n9kd \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"
  • payments: os pagamentos da cobrança, do mais novo para o mais antigo.
  • method e status: o meio e a situação de cada pagamento.
  • chargeIds: os IDs das cobranças que o pagamento cobre. Um pagamento pode quitar mais de uma cobrança do mesmo titular.

Referência: Consultar uma cobrança

Situação da cobrança

Para saber se uma cobrança em aberto mudou, consulte-a pelo id.

SituaçãoSignificado
PENDINGAguardando pagamento.
PAIDPaga.
EXPIREDNão foi paga a tempo. A troca de PENDING para EXPIRED acontece depois de expiresAt, não no mesmo instante.
CANCELLEDCancelada.

A cobrança PENDING, antes de expiresAt, também pode ser paga na hora com o saldo da carteira. Veja Pagar com o saldo da carteira.

Erros

CódigoHTTPMensagem
PZC001400Corpo ou parâmetro fora do formato.
PZC020404Recurso não encontrado.
  • Parâmetro fora do formato: status fora da lista, limit fora de 1 a 100, cursor inválido, ou lineId ou customerId vazio. details diz qual parâmetro corrigir.
  • Recurso não encontrado: a cobrança não existe, é de outro integrador ou é do outro ambiente.
  • Filtro sem resultado: lineId ou customerId que não é seu traz a lista vazia, sem erro.

O limite de chamadas está em Limites de requisição e os erros da chave, em Autenticação.