Consultar um Produto

Esse endpoint permite a consulta dos detalhes de um determinado produto na visão de um Emissor.

Veja mais detalhes sobre os produtos em: https://developers.celcoin.com.br/docs/configurações-de-produto

Parâmetros da URL

  • product_id (string/uuid v4): ID do produto.

Resposta

Em caso de sucesso será retornado um status 200 e um arquivo JSON no seguinte formato:

  • id (string/uuid v4):ID do produto.
  • agreeement_template -> id (string/uuid v4): Identificador único do Modelo de Contrato a ser utilizado para este produto. Vários produtos podem compartilhar o mesmo modelo de contrato.
  • name (string): Nome para identificação do produto.
  • description (string): 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.
  • regulator_product_code (string): Código do BACEN. De acordo com a modalidade de produto estabelecidas no relatório 3040 Bacen/SCR.
  • borrower_type (string): Tipo da pessoa. Possíveis valores: PERSON, BUSINESS.
  • interest_type (string): Tipo da taxa de juros. Possíveis valores: PRE, POS.
  • min_interest_rate (float): Taxa mínima de juros permitida.
  • max_interest_rate (float): Taxa máxima de juros permitida.
  • min_num_payments (int): Quantidade mínima de parcelas.
  • max_num_payments (int): Quantidade máxima de parcelas.
  • fine_rate (float): Valor da multa de mora aplicada para este produto.
  • additional_interest (float): Taxa de juros adicional.
  • variables_configuration (object): Objeto contendo as variaveis de configuração do produto.
  • status (string): Status do cadastro.
  • schedule_type (string): Periodicidade das parcelas. Define o intervalo em dias entre os vencimentos. Mensal=MONTHLY, Diário=DAILY, Semanal=WEEKLY, Bisemanal=BIWEEKLY.
  • iof_zero (boolean): Caso verdadeira, essa flag indica ao sistema que nenhuma originação deste produto sofre incidência de IOF.
  • custom_simulator (object): Variáveis customizadas para a simulação.
  • originator_signature_required (boolean): 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.
  • funding_signature_required (boolean): 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.
  • qualification_required (boolean): 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.
  • conditions_required (boolean): 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.
  • beneficiary_type (string): Tipo do beneficiário. Possíveis valores: BORROWER.
  • amortization_type (string): Tipo da amortização do juros. Possíveis valores: PRICE.
  • interest_compounding_type: Tipo do juros utilizado no cálculo das parcelas, se é simples ou composto. Possíveis valores: COMPOUND, SIMPLE.
  • financed_iof (boolean): Flag para indicar se o IOF será financiado.
  • tac_not_included_cession_amount (boolean): Flag para indicar se a TAC será ou não inclusa no valor da cessão.
  • managed_account_for_issuer_disbursement (object): Conta gerenciada para desembolso do emissor.
  • type_product_emission (string): Tipo de documento a ser emitido. Possíveis valores: "CCB",
  • created_at (datetime): Data de criação do produto.
  • updated_at (datetime): Data da última atualização do produto.
  • version (int): Número sequencial de versionamento.
Objeto "variables_configuration"
  • application (object): Objeto contendo as variáveis personalizadas 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.
  • borrower (object): Objeto contendo as variáveis personalizadas 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.
  • guarantors (object): Objeto contendo as variáveis personalizadas a serem informadas no cadastro dos Avalistas. Análoga a Configuração das Variáveis de Tomadores, para Avalistas.
  • co-signers (object): Objeto contendo as variáveis personalizadas a serem informadas no cadastro dos Anuentes. Análoga a Configuração das Variáveis de Tomadores, para Anuentes.
  • employer (object): Objeto contendo as variáveis personalizadas a serem informadas no cadastro dos Empregadores. 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.
  • business_document, person_document (objeto): Lista de Documentos obrigatórios ou opcionais no cadastro de pessoas físicas ou jurídicas como Tomadores.
  • employer_document (object): Análogo a Documentos Tomador, para Empregadores. Apenas pessoas jurídicas.

Exemplo de resposta

{
      "id": "<uuid>",
      "agreement_template": {
        "id": "<uuid>"
      },
      "name": "<string>",
      "description": "<string>",
      "regulator_product_code": "<string>",
      "borrower_type": "BUSINESS",
      "interest_type": "PRE",
      "min_interest_rate": "<number>",
      "max_interest_rate": "<number>",
      "min_num_payments": "<integer>",
      "max_num_payments": "<integer>",
      "fine_rate": "<number>",
      "additional_interest": "<double>",
      "variables_configuration": {
        "application": [
          {
            "id": "<uuid>",
            "name": "<string>",
            "required": "<boolean>",
            "type": "TEXT",
            "display_name": "<string>",
            "description": "<string>"
          },
          {
            "id": "<uuid>",
            "name": "<string>",
            "required": "<boolean>",
            "type": "DATE",
            "display_name": "<string>",
            "description": "<string>"
          }
        ],
        "borrower": {
          "person": [
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "DATE",
              "display_name": "<string>",
              "description": "<string>"
            },
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "NUMBER",
              "display_name": "<string>",
              "description": "<string>"
            }
          ],
          "business": [
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "TEXT",
              "display_name": "<string>",
              "description": "<string>"
            },
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "DATE",
              "display_name": "<string>",
              "description": "<string>"
            }
          ],
          "person_document": [
            {
              "type": "<string>",
              "required": "<boolean>"
            },
            {
              "type": "<string>",
              "required": "<boolean>"
            }
          ],
          "business_document": [
            {
              "type": "<string>",
              "required": "<boolean>"
            },
            {
              "type": "<string>",
              "required": "<boolean>"
            }
          ]
        },
        "guarantors": {
          "person": [
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "BOOLEAN",
              "display_name": "<string>",
              "description": "<string>"
            },
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "BOOLEAN",
              "display_name": "<string>",
              "description": "<string>"
            }
          ],
          "business": [
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "BOOLEAN",
              "display_name": "<string>",
              "description": "<string>"
            },
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "NUMBER",
              "display_name": "<string>",
              "description": "<string>"
            }
          ],
          "person_document": [
            {
              "type": "<string>",
              "required": "<boolean>"
            },
            {
              "type": "<string>",
              "required": "<boolean>"
            }
          ],
          "business_document": [
            {
              "type": "<string>",
              "required": "<boolean>"
            },
            {
              "type": "<string>",
              "required": "<boolean>"
            }
          ]
        },
        "co_signers": {
          "person": [
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "NUMBER",
              "display_name": "<string>",
              "description": "<string>"
            },
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "DATE",
              "display_name": "<string>",
              "description": "<string>"
            }
          ],
          "business": [
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "BOOLEAN",
              "display_name": "<string>",
              "description": "<string>"
            },
            {
              "id": "<uuid>",
              "name": "<string>",
              "required": "<boolean>",
              "type": "BOOLEAN",
              "display_name": "<string>",
              "description": "<string>"
            }
          ],
          "person_document": [
            {
              "type": "<string>",
              "required": "<boolean>"
            },
            {
              "type": "<string>",
              "required": "<boolean>"
            }
          ],
          "business_document": [
            {
              "type": "<string>",
              "required": "<boolean>"
            },
            {
              "type": "<string>",
              "required": "<boolean>"
            }
          ]
        },
        "employer": [
          {
            "id": "<uuid>",
            "name": "<string>",
            "required": "<boolean>",
            "type": "NUMBER",
            "display_name": "<string>",
            "description": "<string>"
          },
          {
            "id": "<uuid>",
            "name": "<string>",
            "required": "<boolean>",
            "type": "TEXT",
            "display_name": "<string>",
            "description": "<string>"
          }
        ],
        "employer_document": [
          {
            "type": "<string>",
            "required": "<boolean>"
          },
          {
            "type": "<string>",
            "required": "<boolean>"
          }
        ]
      },
      "status": "PENDING_CONFIGURATION",
      "schedule_type": "WEEKLY",
      "iof_zero": "<boolean>",
      "custom_simulator": {
        "version_identifier": "<string>",
        "metadata": {
          "values": {
            "cupidatat_4_": {
              "value": [
                "<string>",
                "<string>"
              ],
              "sensitive": "<boolean>"
            },
            "laborum_4c": {
              "value": [
                "<string>",
                "<string>"
              ],
              "sensitive": "<boolean>"
            },
            "magna3c0": {
              "value": [
                "<string>",
                "<string>"
              ],
              "sensitive": "<boolean>"
            }
          }
        }
      },
      "originators": [
        {
          "id": "<uuid>",
          "legal_name": "<string>"
        },
        {
          "id": "<uuid>",
          "legal_name": "<string>"
        }
      ],
      "originator_signature_required": "<boolean>",
      "funding_signature_required": "<boolean>",
      "qualification_required": "<boolean>",
      "conditions_required": "<boolean>",
      "beneficiary_type": "BAAS_ACCOUNT",
      "amortization_type": "AMERICAN",
      "interest_compounding_type": "COMPOUND",
      "financed_iof": "<boolean>",
      "managed_account_for_issuer_disbursement": {
        "if_existing": "REUSE",
        "type": "BORROWER_ACOUNT_FOR_ORIGINATOR"
      },
      "created_at": "<dateTime>",
      "updated_at": "<dateTime>",
      "version": "<integer>"
}

Language
URL
Click Try It! to start a request and see the response here!