PayZu CellLinhasConsulta

Listar as linhas

GET/v1/lines

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 linha. A compra que espera o pagamento não é linha no /v1.
planIdstring
Filtra pelo plano atual.
searchstring
Número (com ou sem 55 e máscara), começo do ICCID, apelido da linha, ou nome, e-mail ou documento do titular.
customerIdstring
Filtra por titular.

Headers

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

Responses

200Lista de linhas
dataarray of objectsItens da página.
Campos de cada item 21
idstringIdentificador da linha.
environmentstringAmbiente do dado: produção ou testes.
LIVETEST
customerIdstringTitular da linha.
customerobjectTitular da linha.
Campos do objeto 2
namestringNome do titular.
documentstringCPF ou CNPJ do titular, sem máscara; CNPJ alfanumérico com letras em maiúscula.
partnerIdstring | nullID do integrador dono da linha.
nicknamestring | nullApelido da linha; nulo sem apelido.
planobjectPlano atual da linha.
Campos do objeto 3
idstringPlano atual.
namestringNome do plano atual.
pricenumberValor em reais, número com até duas casas, como 29.9.
nextPlanIdstring | nullPlano que entra na próxima renovação.
msisdnstring | nullNúmero com DDI e DDD; nulo antes da ativação.
iccidstringICCID do chip.
simTypestringChip físico ou eSIM.
PHYSICALESIM
statusstringSituação da linha. A compra que espera o pagamento não é linha no /v1.
SHIPPINGACTIVATINGACTIVATION_FAILEDACTIVERESTRICTEDBLOCKEDGRACECANCELLEDCLOSED_BY_NETWORKUNKNOWN
biometryStatusstring | nullSituação da biometria.
PENDINGSUCCESSFAILEDERROR
cycleEndsOnstring | nullÚltimo dia do ciclo pago.
renewedUntilstring | nullFim do ciclo seguinte quando a renovação dele já está paga e a recarga agendada para cycleEndsOn: um mês depois de cycleEndsOn. Nulo sem renovação paga do próximo ciclo.
dueDayinteger | nullDia de vencimento fixado para a linha.
billingExemptbooleanLinha isenta de cobrança.
recurringCardobject | nullCartão recorrente ativo ou agendado; nulo quando a linha paga cada fatura por Pix ou cartão avulso.
Campos do objeto 4
statusstringACTIVE: a assinatura cobra o cartão todo mês. SCHEDULED: o cartão está salvo e a assinatura começa no próximo vencimento, pagando a renovação dele.
ACTIVESCHEDULED
brandstring | nullBandeira do cartão; nula quando o provedor não informa.
lastDigitsstringÚltimos dígitos do cartão.
nextChargeOnstring | nullDia da próxima cobrança no cartão; nulo quando o provedor não informa.
activatedAtstring | nullInstante ISO 8601 com fuso.
cancelledAtstring | 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/lines \     --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