Status
O que significa cada status de venda e de contrato no PrincipiaPay.
O status mostra em que ponto do funil está cada venda, do checkout criado até o pagamento.
Status da venda (status)
É o campo status devolvido nas consultas de venda (GET /sales/purchase/{saleId} e GET /sales/external-purchase/{externalSaleId}). Compare pelo texto exato da primeira coluna, com a mesma grafia e acentuação.
status | Código interno | Significado |
|---|---|---|
Não acessado | not_logged | O checkout foi criado, mas o aluno ainda não entrou. É o status logo depois de POST /sales. |
Informações pessoais incompletas | basic_info_incomplete, basic_info_review | O aluno entrou, mas os dados pessoais estão incompletos ou em revisão. |
Informações de documentos incompletas | document_info_incomplete, document_info_review | Faltam documentos do aluno (ex.: a selfie) ou eles estão em revisão. |
Aguardando indicar avalista | guarantor_needed | O aluno precisa indicar um avalista para seguir. |
Informações de avalista incompletas | guarantor_incomplete, guarantor_review | O avalista foi indicado, mas não concluiu as etapas dele ou está em revisão. |
Em análise | analysis | A venda está na análise de crédito. |
Aguardando geração do contrato | approved | Aprovado; o contrato está sendo gerado para assinatura. |
Aguardando assinatura | waiting_signature | O contrato ainda não foi assinado pelo aluno e/ou pelo avalista. |
Aguardando pagamento | waiting_payment | O pagamento ainda não foi confirmado (boleto pode levar alguns dias úteis para compensar). |
Compra recusada | payment_refused | O aluno escolheu cartão de crédito e a última tentativa foi recusada. |
Financiamento negado | financing_denied | O boleto parcelado foi negado, mas o aluno ainda pode escolher outra forma de pagamento. |
Negado | denied | O financiamento não foi aprovado e não há outra forma de pagamento disponível. |
Desistência | abandonment_before_signed, abandonment_after_signed, isa_abandonment_after_signed | O aluno não concluiu a compra (antes ou depois de assinar). |
Cancelado | abandonment_after_upfront, abandonment_after_settled | A compra foi cancelada depois do pagamento da entrada (antes ou depois do repasse ao parceiro). |
Link Inativo | link_inactive | O parceiro cancelou o checkout antes de o aluno entrar. |
Expirado | expired | O checkout expirou antes de o aluno entrar. |
Efetivado | made_effective | A compra foi efetivada. |
Default | isa_default | Aluno de ISA identificado como irregular. |
Status nulo ou não mapeado
Em algumas combinações de etapas a venda não se encaixa em nenhuma linha desta tabela, e o status vem null. Se a API encontrar um status interno sem tradução, ela devolve o próprio código interno (em inglês). Trate null e valores desconhecidos sem quebrar, por exemplo mantendo o último status conhecido e esperando o próximo evento de webhook.
Situação do contrato
Depois da efetivação, a venda aparece em Vendas Efetivadas no painel, com a situação do contrato:
| Situação | Significado |
|---|---|
| Efetivado | A compra foi efetivada. |
| Quitado | O aluno pagou todo o financiamento. |
| Cancelado | O aluno pagou a entrada e pediu o cancelamento depois do repasse ao parceiro. |
| Desistência após a Entrada | O aluno pagou a entrada e cancelou antes do repasse ao parceiro. |
| Negativado | O aluno não pagou o financiamento e foi negativado. |
| Protestado | O aluno não pagou o financiamento e foi protestado em cartório. |
| Pendente | Só crédito educacional dinâmico: a fatura do mês ainda não foi paga. |
| Pago | Só crédito educacional dinâmico: a fatura do mês foi paga. |
| Inadimplente | Só crédito educacional dinâmico: a fatura está atrasada há mais de 3 dias. |
Códigos de status (legado)
As rotas e os webhooks mais antigos (por exemplo GET /sales, vendas exclusivas e as rotas de Webhooks legado) podem trazer o status como código em inglês:
| Código | Significado |
|---|---|
not_logged | O checkout foi criado, mas o aluno ainda não entrou. |
logged | O aluno entrou na plataforma. |
basic_info_incomplete | Dados básicos incompletos. |
basic_info_review | Dados básicos em revisão pelo nosso time. |
document_info_incomplete | Faltam documentos. |
document_info_review | Documentos enviados e em análise. Aqui roda a análise de crédito automática, que define se é preciso avalista. |
analysis | A análise automática não aprovou e a venda foi para o time de crédito. |
guarantor_needed | O aluno precisa indicar um avalista. |
guarantor_incomplete | O avalista foi indicado, mas não concluiu as etapas dele. |
guarantor_review | Dados do avalista em análise. |
waiting_signature | Aluno e avalista (se houver) receberam o contrato por e-mail e precisam assinar. |
abandonment_before_signed | O aluno chegou à assinatura, mas não seguiu. |
abandonment_after_signed | O aluno assinou, mas não fez o primeiro pagamento. |
waiting_payment | Pagamento em análise de risco (cartão) ou aguardando compensação do boleto (até 3 dias úteis). |
approved | A solicitação foi aprovada. |
abandonment_after_upfront | O aluno pagou a entrada, mas desistiu. |
made_effective | A venda foi efetivada e o aluno está ativo. |
abandonment_after_settled | A venda foi cancelada depois do repasse ao parceiro. |
link_inactive | O parceiro cancelou o checkout antes do aluno entrar. |
expired | O checkout expirou antes do aluno entrar. |
denied | O financiamento não foi aprovado. |