PayZu CellCobranças

Listar as cobranças

GET/v1/charges

Confira o passo a passo → https://docs.payzu.com.br/docs/cell/monthly-charges


Query Params

cursorstring
Cursor retornado em nextCursor da página anterior; vazio vale como ausente.
limitintegerPadrão: 20
Quantidade de itens por página.
statusstring enum
Situação da cobrança.
lineIdstring
Filtra pela linha.
customerIdstring
Filtra pelo titular.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Lista de cobranças
dataarray of objectsItens da página.
Campos de cada item 13
idstringIdentificador da cobrança.
environmentstringAmbiente do dado: produção ou testes.
LIVETEST
customerIdstringID do titular cobrado.
customerNamestringNome do titular da cobrança.
lineIdstring | nullID da linha cobrada, quando houver.
lineMsisdnstring | nullNúmero da linha cobrada; nulo enquanto a linha não tem número.
kindstringAtivação, renovação, reativação ou troca de plano.
ACTIVATIONRENEWALREACTIVATIONPLAN_CHANGE
statusstringSituação da cobrança.
PENDINGPAIDEXPIREDCANCELLED
amountnumberValor em reais, número com até duas casas, como 29.9.
dueOnstringDia de vencimento.
expiresAtstringDepois disso a cobrança expira.
paidAtstring | nullInstante ISO 8601 com fuso.
createdAtstringInstante ISO 8601 com fuso.
nextCursorstring | nullCursor da próxima página; nulo na última.
400Requisição inválida
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
401Chave ausente ou inválida
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
403Acesso negado
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.payzucell.com.br/v1/charges \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json