PayZu CellLinhasConsulta

Consultar o consumo de uma linha

GET/v1/lines/{id}/consumption

Confira o passo a passo → https://docs.payzu.com.br/docs/cell/line-balance-and-consumption


Path Params

idstringobrigatório
ID da linha.

Query Params

monthstring
Mês consultado; padrão é o mês corrente em Brasília.

Headers

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

Responses

200Consumo do mês
msisdnstringNúmero da linha, com DDI e DDD.
monthstringMês no formato YYYY-MM.
dataBytesnumberDados consumidos em bytes.
zeroRatingBytesnumberDados de apps sem desconto da franquia, em bytes.
zeroRatingByAppobjectBytes sem desconto por app.
voiceSecondsnumberVoz em segundos.
smsCountnumberSMS enviados.
daysarray of objectsConsumo de cada dia do mês.
Campos de cada item 5
datestringDia do consumo.
dataBytesnumberDados consumidos no dia, em bytes.
zeroRatingBytesnumberDados sem desconto da franquia no dia, em bytes.
voiceSecondsnumberVoz no dia, em segundos.
smsCountnumberSMS enviados no dia.
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.
404Linha não encontrada
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.
409Conflito
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.
422Operação recusada
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.
429Limite de requisições atingido
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.
502Operadora sem resposta
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.
requestIdstringID da requisição, só nos erros 5xx.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.payzucell.com.br/v1/lines/{id}/consumption \     --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