Antes de começar
- Você precisa de um token bearer do Lender (um JWT emitido pelo seu Access Manager). Cada operação é autenticada e tem escopo por tenant.
- Decida a qual jurisdição o produto pertence — a base genérica ou o Brasil. Produtos brasileiros carregam campos extras cobertos no Pacote regulatório do Brasil.
Passos
Crie o produto
POST /api/v1/loan-products registra o produto nomeado. Esta é a entrada de catálogo da qual as versões dependem. (O Brasil tem um alias, POST /api/v1/br/loan-products, que aceita as extensões BR.)Crie uma versão
POST /api/v1/loan-products/{id}/versions congela um conjunto de termos — configuração de taxa, prazo e forma do cronograma — como uma versão imutável. Cada empréstimo rastreia a versão com a qual foi originado; você nunca edita uma versão, você publica uma nova.Anexe encargos
POST /api/v1/loan-products/{id}/charges aplica um template de encargo (uma tarifa de originação, uma tarifa de serviço) que os empréstimos originados a partir deste produto herdam.Amarre um perfil contábil
POST /api/v1/loan-products/{id}/accounting-profiles declara como o produto contabiliza no : as regras de posting (quais lançamentos de partidas dobradas disparam para cada evento) e a organização de ledger e o ledger em que são contabilizados. Sem um perfil, o produto não pode fazer posting. Veja Contabilidade e rotinas de apropriação.Inspecionar produtos
| Operação | Propósito |
|---|---|
GET /api/v1/loan-products | Lista os produtos de empréstimo. |
GET /api/v1/loan-products/{id} | Lê um produto e suas versões. |
GET /api/v1/loan-products/{id}/floating-rates | Lê a tabela de taxa flutuante do produto, se ele referenciar uma. |
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 streaming — veja O Lender na plataforma.
Próximos passos
Originar um empréstimo
Pegue um produto ativo e origine um empréstimo contra ele.