Pular para o conteúdo principal
Um produto de empréstimo é o template a partir do qual todo empréstimo é originado. Definir um é uma sequência curta: crie o produto, versione os termos dele, descreva como ele é contabilizado no ledger e depois ative o produto. Você origina cada empréstimo contra uma versão de produto, e a ativação precisa que essa versão carregue um perfil contábil.

​
Antes de começar

  • Você precisa de um bearer token do Lender (um JWT emitido pelo seu Access Manager). Cada operação é autenticada e delimitada por tenant.
  • Decida a qual jurisdição o produto pertence. O crédito é registrado sob a jurisdição Brasil. A base genérica, XX, não registra crédito. Produtos brasileiros carregam campos extras cobertos no Pacote regulatório Brasil.

​
Passos

1

Crie o produto

POST /api/v1/loan-products registra o produto nomeado. Essa é a entrada de catálogo na qual as versões se penduram. (O Brasil tem um alias, POST /api/v1/br/loan-products, que aceita as extensões BR.)
2

Crie uma versão

POST /api/v1/loan-products/{id}/versions congela um conjunto de termos (configuração de taxa, prazo e o formato do cronograma) como uma versão imutável. Todo empréstimo remete à versão que ele usou na originação. Você nunca edita uma versão, você publica uma nova. Uma versão deve declarar sua faixa de taxa e os tipos de tomador que admite, ou não origina nada.
3

Anexe encargos

POST /api/v1/loan-product-versions/{id}/charge-templates declara um template de encargo em uma versão. POST /api/v1/loan-products/{id}/charges o aplica a uma conta de empréstimo.
4

Vincule um perfil contábil

POST /api/v1/loan-products/{id}/accounting-profiles declara como o produto é contabilizado no . O perfil carrega as regras de lançamento (quais pernas de partidas dobradas disparam para cada evento) e a organização de ledger e o ledger em que elas são contabilizadas. A ativação recusa uma versão sem perfil. Veja Contabilidade e rodadas de apropriação.
5

Ative o produto

POST /api/v1/loan-products/{id}/activate deixa o produto ativo e fixa a versão que você nomeia como a versão atual dele. Até a ativação, o produto não origina nada. Uma versão brasileira também precisa da sua carteira, normPortfolioClass, antes de ser ativada. Cada proposta nomeia a versão que ela usa na originação, então os empréstimos existentes ficam com a versão em que começaram.

​
Promova uma versão nova

A ativação fixa a primeira versão. A promoção fixa todas as seguintes. Ela reaponta um produto que já está vivo para outra versão corrente, sem derrubar o produto e subir de novo. POST /api/v1/loan-products/{id}/promote nomeia a versão a fixar. O Brasil tem um alias, POST /api/v1/br/loan-products/{id}/promote, que se comporta de forma idêntica. A promoção carrega as mesmas duas checagens de prontidão que a ativação carrega: um perfil contábil presente e uma versão completa para a jurisdição dela. Ela as carrega porque é o mesmo ato. Um segundo caminho sem elas seria uma forma silenciosa de burlar o primeiro.
A promoção não muda contrato nenhum nem proposta nenhuma. Todo empréstimo já escrito fica com a versão em que nasceu. O cronograma, a precificação e os encargos dele leem daquela versão a vida inteira do empréstimo. Toda proposta ainda em voo também fica com a versão dela. Só propostas novas leem a versão corrente.

​
Inspecionando produtos

Um produto com taxa flutuante resolve a taxa aplicável na tabela quando o cronograma precisa dela, em vez de fixar uma taxa fixa na originação.

​
O que acontece downstream

Criar e ativar produtos emite loan_product.created, loan_product_version.created, loan_product.activated, accounting_profile.configured e loan_charge.applied no backbone de eventos (veja O Lender na plataforma).

​
Próximos passos

Origine um empréstimo

Pegue um produto ativo e origine um empréstimo contra ele.