PayZu CellAtivação
Acompanhar a compra de uma linha
GET/v1/activations/{lineId}
Requisições recentes
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Compra encontrada
lineobjectLinha depois da operação.
Campos do objeto 21
idstringIdentificador da linha.
environmentstringAmbiente do dado: produção ou testes.
LIVETESTcustomerIdstringTitular 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.
PHYSICALESIMstatusstringSituação da linha.
DRAFTPENDING_PAYMENTSHIPPINGACTIVATINGACTIVATION_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 | nullInstante ISO 8601 com fuso.
cancelledAtstring | nullInstante ISO 8601 com fuso.
createdAtstringInstante ISO 8601 com fuso.
chargeobjectCobrança gerada.
Campos do objeto 13
idstringIdentificador da cobrança.
environmentstringAmbiente do dado: produção ou testes.
LIVETESTcustomerIdstringID 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_CHANGEstatusstringSituação da cobrança.
PENDINGPAIDEXPIREDCANCELLEDamountnumberValor 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 compra, ou o pagamento com saldo quando a compra foi paga com BALANCE. Nulo quando o provedor de pagamento não respondeu ou o saldo mudou antes do débito, e então você paga pela 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.
PIXCARDBOLETOWALLETBALANCEstatusstringSituação do pagamento.
PENDINGPAIDFAILEDEXPIREDCANCELLEDREFUNDEDamountnumberValor 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.
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.
404Compra 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?