PayZu CellLinhasRenovação e plano

Trocar o plano de uma linha

POST/v1/lines/{id}/change-plan

Confira o passo a passo → https://docs.payzu.com.br/docs/cell/pay-with-balance


Path Params

idstringobrigatório
ID da linha.

Body Params

planIdstringobrigatório
ID do plano novo.
timingstring enumobrigatório
NEXT_CYCLE vale na próxima renovação; NOW cobra o plano novo e recarrega agora.
channelstring enumPadrão: PIX
Vale só com timing igual a NOW; com NEXT_CYCLE não há cobrança e o campo é ignorado. PIX gera o Pix da cobrança ou retorna o Pix ainda aberto dela. BALANCE paga a cobrança com o saldo da carteira da empresa no ambiente da chave; com o débito ainda em confirmação, payment vem nulo e a cobrança é paga quando ele confirmar.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
Idempotency-Keystringobrigatório
Obrigatório nas rotas que geram cobrança ou recarga. Seu identificador do pedido, válido por 24 h em cada ambiente. Depois de um sucesso, repetir a mesma rota com o mesmo corpo retorna a mesma resposta, com Idempotent-Replayed: true; outro corpo ou outra rota responde 409 PZC004, e o pedido ainda em andamento responde 409 PZC201.
acceptstring
Formato da resposta.

Responses

200Troca registrada
lineobjectLinha depois da operação.
Campos do objeto 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.
chargeobject | nullCobrança gerada.
Campos do objeto 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.
paymentobject | nullPix da cobrança, ou o pagamento com saldo quando channel é BALANCE. Nulo sem cobrança ou com o débito do saldo ainda em confirmação, e então a cobrança é paga sozinha quando ele confirmar.
Campos do objeto 11
idstringID do pagamento.
orderIdstringPedido de pagamento a que o pagamento pertence; é a referência dele no provedor.
chargeIdsarray of stringsFaturas cobertas pelo pedido do pagamento.
methodstringMeio usado; WALLET é saldo ou crédito na carteira do provedor; BALANCE é o saldo da carteira da empresa.
PIXCARDBOLETOWALLETBALANCE
statusstringSituação do pagamento.
PENDINGPAIDFAILEDEXPIREDCANCELLEDREFUNDED
amountnumberValor em reais, número com até duas casas, como 29.9.
pixCopyPastestring | nullPix copia e cola.
pixQrCodestring | nullQR do Pix em PNG base64.
expiresAtstring | nullData e hora em que o pagamento expira.
paidAtstring | nullInstante ISO 8601 com fuso.
createdAtstringInstante ISO 8601 com fuso.
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.
502Pagamento 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 POST \     --url https://api.payzucell.com.br/v1/lines/{id}/change-plan \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

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

application/json