Configurações de Produto
Lista da Configurações a serem utilizadas no Cadastro ou Atualização de um produto.
Estes campos são usados para Criação, Edição e Consulta de Produtos.
| Nome da configuração | Caminho | Descrição |
|---|---|---|
| Modelo de Contrato | agreement_template.id | Identificador único do Modelo de Contrato a ser utilizado para este produto. Vários produtos podem compartilhar o mesmo modelo de contrato. Atenção: Caso você cadastre um modelo de contrato incompatível com este produto, os contratos gerados acabarão mal formados |
| Tipo de tomador | borrower_type | Define se os tomadores deste produto serão pessoas físicas (PERSONS) ou jurídicas (BUSINESS) |
| Condições são obrigatórias? | conditions_required | Define se todos os tomadores precisam ter condições definidas. Isto é, uma Qualificação com condições preenchidas, como Limites, Taxas de Juros e Ratings. Em conjunto com a flag qualification_required, força a aprovação e estabelecimento de condições para todos os tomadores. Tomadores sem qualificações com condições terão suas solicitações rejeitadas. Adicionalmente, todas as solicitações serão validadas contra as condições estabelecidas na qualificação. |
| Descrição | description | Essa breve descrição do Produto é utilizada para apresentação em UIs, provendo contexto aos usuários. Não deve ser usada para comunicação máquina-a-máquina. |
| Multa de Mora | fine_rate | Valor da multa de mora aplicada para este produto. A multa de mora é aplicada uma única vez no atraso, sob o valor do vencimento. |
| Assinatura do Funding é obrigatória? | funding_signature_required | Determina se todas as operações de crédito deste produto devem ter o representante legal do credor como signatário. Antes de assinadas pelo credor, nenhuma cédula terá valor. |
| Tipo de juros | interest_type | Define se os juros serão pós ou pré-fixados. O padrão é pré-fixado. |
| IOF Zerado? | iof_zero | Caso verdadeira, essa flag indica ao sistema que nenhuma originação deste produto sofre incidência de IOF (Imposto sobre Operações Financeiras) |
| Taxa de Juros Máxima | max_interest_rate | Esse parâmetro impede que sejam geradas solicitações com taxa de juros superior ao valor indicado. |
| Taxa de Juros Mínima | min_interest_rate | Esse parâmetro impede que sejam geradas solicitações com taxa de juros inferior ao valor indicado. |
| Prazo máximo | max_num_payments | Esse parâmetro impede que sejam geradas solicitações com prazo superior ao valor indicado. |
| Prazo mínimo | min_num_payments | Esse parâmetro impede que sejam geradas solicitações com prazo inferior ao valor indicado. |
| Nome | name | Nome do produto. Não deve ser utilizado para comunicação máquina-a-máquina. |
| Assinatura do Originador é obrigatória? | originator_signature_required | Determina se todas as operações de crédito deste produto devem ter o representante legal do originador como signatário. Antes de assinadas pelo originador, nenhuma cédula terá valor. |
| Originadores Credenciados | originators[*].id | Lista dos Originadores capazes de criar solicitações para este produto |
| Qualificação é Obrigatória? | qualification_required | Esta flag determina que todas as solicitações de tomadores sem uma qualificação no status=QUALIFIED devem ser rejeitadas. Útil para realizar a gestão do processo de aprovação de tomadores. |
| Código BACEN | regulator_product_code | De acordo com a modalidade de produto estabelecidas no relatório 3040 Bacen/SCR |
| Periodicidade dos vencimentos | schedule_type | Define o intervalo em dias entre os vencimentos. Mensal=MONTHLY, Diário=DAILY, Semanal=WEEKLY, Bisemanal=BIWEEKLY |
| Configuração das Variáveis de Solicitação | variables_configuration.application | Variáveis personalizadas para Solicitações. A serem informadas na Solicitação (application). Cada variável deve ter um nome (name) e obrigatoriedade (required). O nome deve ser compatível com o nome da variável previamente cadastrada, e prefixado com "custom_variables". Ex: Se a variável foi cadastrada como "xyz" no endpoint de variáveis, aqui ela será representada como "custom_variables.xyz", seja para escrita ou leitura. |
| Configuração das Variáveis de Tomadores | variables_configuration.borrower.{business,person} | Variáveis personalizadas para Tomadores a serem informadas no cadastro de Pessoas (persons) ou Empresas (business). Para produtos de crédito PJ, preencher a lista business, para PF, a lista person. Cada variável deve ter um nome (name) e obrigatoriedade (required). O nome deve ser compatível com o nome da variável previamente cadastrada, e prefixado com "custom_variables". Ex: Se a variável foi cadastrada como "xyz" no endpoint de variáveis, aqui ela será representada como "custom_variables.xyz", seja para escrita ou leitura. |
| Configuração das Variáveis de Avalistas | variables_configuration.guarantors.{business,person} | Análoga a Configuração das Variáveis de Tomadores, para Avalistas. |
| Configuração das Variáveis de Anuentes | variables_configuration.co_signers.{business,person} | Análoga a Configuração das Variáveis de Tomadores, para Anuentes. |
| Configuração das Variáveis de Empregadores | variables_configuration.employer | Análoga a Configuração das Variáveis de Tomadores, para Empregadores. Válida apenas para pessoas jurídicas. É utilizada principalmente em operações de consignado privado. |
| Documentos Tomador | variables_configuration.borrower.{business_document,person_document} | Lista de Documentos obrigatórios ou opcionais no cadastro de pessoas físicas ou jurídicas como Tomadores. |
| Documentos Avalista | variables_configuration.guarantors.{business_document,person_document} | Análogo a Documentos Tomador, para Avalistas. |
| Documentos Anuente | variables_configuration.co_signers.{business_document,person_document} | Análogo a Documentos Tomador, para Anuentes. |
| Documentos Empregador | variables_configuration.employer_documents | Análogo a Documentos Tomador, para Empregadores. Apenas pessoas jurídicas. |
| Identificador | id | Identificador único do produto. Recomendado para comunicação máquina-a-máquina. |
Updated 12 months ago