PayZu CellLinhasChip e apelido
Dar ou tirar o apelido de uma linha
PATCH/v1/lines/{id}
Requisições recentes
Path Params
idstringobrigatório
ID da linha.
Body Params
nicknamestringobrigatório
Apelido da linha, até 40 caracteres contados depois de tirar os espaços das pontas, sem caractere de controle. Nulo ou texto vazio tira o apelido.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Linha com o apelido
idstringIdentificador da linha.
environmentstringAmbiente do dado: produção ou testes.
LIVETESTcustomerIdstringID do titular cobrado.
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 da linha, com DDI e DDD.
iccidstringICCID do chip.
simTypestringChip físico ou eSIM.
PHYSICALESIMstatusstringSituação da linha. A compra que espera o pagamento não é linha no /v1.
SHIPPINGACTIVATINGACTIVATION_FAILEDACTIVERESTRICTEDBLOCKEDGRACECANCELLEDCLOSED_BY_NETWORKUNKNOWNbiometryStatusstring | nullSituação da biometria.
PENDINGSUCCESSFAILEDERRORcycleEndsOnstring | 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.
ACTIVESCHEDULEDbrandstring | 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 | nullData e hora da ativação.
cancelledAtstring | nullData e hora do cancelamento.
createdAtstringData e hora do registro.
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.
Esta página ajudou?