FAQ

A inclusão de parcelas é síncrona?

Não. A inclusão de parcelas e alunos é assíncrona: você envia um lote e acompanha o processamento pelas rotas de status. Não assuma conclusão na resposta imediata.

Qual versão de rota devo usar?

Sempre a mais recente disponível (ex.: v3/liquidacoes, v2/acordos). As versões anteriores são mantidas apenas por compatibilidade.

Como evito duplicar parcelas em um reenvio?

Use identificadores estáveis (como id_agrupador). Assim, reenvios do mesmo lote não geram duplicidade.

Onde testo sem afetar dados reais?

No ambiente de staging. Cada ambiente tem sua própria chave.

Posso testar as rotas sem escrever código?

Sim. Cada página das Rotas da API tem um playground para enviar a requisição direto da documentação.

Nenhum cartão passa em staging. O que fazer?

Quase sempre não é o cartão. A causa mais comum é o responsável financeiro sem e-mail válido: o pagamento é recusado na validação antes de chegar ao cartão, então trocar de cartão não muda nada. Cadastre um e-mail no responsável financeiro e use 4111 1111 1111 1111. Detalhes em Ambientes.

Como dou baixa em uma parcela pelo meu lado?

Reenviando a própria parcela em POST /v1/parcela com o mesmo idParcela, situacaoBaixa: "LIQUIDADA" e o bloco pagamento. É self-service, não depende de ninguém na Principia. Veja o passo Atualize, cancele ou dê baixa manual.

Repare que são duas direções diferentes: essa rota é a IES avisando a Principia de um pagamento que ela recebeu; já GET /v3/liquidacoes é a Principia devolvendo à IES os pagamentos que nós recebemos, para você lançar no seu sistema de gestão.

Não achei o que preciso. E agora?

Use o botão Perguntar à IA (canto inferior direito): ele busca em toda esta documentação. Se ainda assim não resolver, fale com o seu contato na Principia.