Pular para o conteúdo principal

SettingsProducts

Configurações de produtos

eligibility object
typestring

Define como a elegibildiade será calculada.

O tipo mock deve ser usado apenas para testes. Use dynamic para integrar com uma API externa. Para produtos que não exigem verificações, use o tipo static.

Possible values: [static, dynamic, mock]

Example: static
options object
anyOf
offer
typestring

Use o tipo online quando o processamento do produto e oferta serão feitos pela plataforma. Use offline para redirecionamento externo.

Possible values: [online, offline, mock]

Example: online
options object
anyOf
monthlyFeenumber

Taxa de juros mensal

Example: 1.99
numberOfInstallmentsinteger[]

Opções de parcelas

Example: [12,24]
daysUntilDisbursementinteger

Dias até o desembolso. Essa informação é usada para calcular a oferta.

Example: 7
monthsUntilFirstDueDateinteger

Quantidade de meses de carência até o vencimento da primeira parcela.

Example: 1
creditOperationTypestring

Tipo da operação de crédito.

Example: CCB
rebates object[]
  • Array [
    • anyOf
    feeTypestringrequired

    Tipo da tarifa.

    all_loans: utilizado para indicar tarifas ou taxas de manutenção em cada contratação. first_loan: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC). except_first_loan: utilizado para representar taxas de manutenção em cada contratação, exceto a primeira.

    Possible values: [all_loans, first_loan, except_first_loan]

    Example: first_loan
    amountTypestringrequired

    Tipo do valor a ser cobrado.

    Possible values: [percentage]

    Example: percentage
    amountdoublerequired

    Porcentagem da tarifa a ser cobrado sobre o valor do empréstimo.

    Example: 0.2
    descriptionstringrequired

    Descrição para a tarifa.

    Example: Tarifa de cadastro
    minAmountnumber

    Valor mínimo para aplicação da tarifa.

    Example: 200
    maxAmountnumber

    Valor máximo para aplicação da tarifa.

    Example: 2000
  • ]
    • insurance object
    amountnumber
    Example: 0
    feenumber
    Example: 1.73
    typestring

    Possible values: [required, optional, uninsured]

    Example: required
    numberstring
    Example: 123456
    insurerstring
    Example: Cia de Seguros
    documents object
    toCreate object[]deprecated

    Documentos criados após a criação do empréstimo, exemplos: ccb, seguro, etc… ATENÇÃO: Este campo entrará em desuso em breve, utilize os steps para definir quais documentos deverão ser criados.

  • Array [
    • purposestring

    Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, insurance_signature, insurance_signed]

    methodstring

    Template engine usado para gerar documentos.

    Possible values: [google]

    methodData object
    templatestring

    Template utilizado no engine para gerar o documento.

  • ]
    • toRequest object[]

    documentos solicitados durante o fluxo de contratação, exemplos: RG, CPF, Holerite, Comprovante de endereço…

  • Array [
    • purposestring

    Possible values: [account_requirement, org_icon, org_logo, identity_document, additional_verification, selfie, ccb, signature, ccb_signed, insurance, identity_document_front, identity_document_back, pay_stub, proof_of_address, insurance_signature, insurance_signed]

    namestring

    Nome do documento.

    Example: crédito consignado
    ownerstring

    Identificador do responsável por solicitar/criar o documento.

    Possible values: [customer, operator]

    Example: customer
    expireInDaysinteger

    Número de dias até a expiração.

    Possible values: >= 1

    Example: 30
  • ]
    • disbursementstring

    Nome do método de desembolso configurado na API de Configurações

    Example: custom
    SettingsProducts
    {
      "eligibility": {
        "type": "static",
        "options": {
          "url": "string",
          "headers": {},
          "metadata": {}
        }
      },
      "offer": {
        "type": "online",
        "options": {
          "monthlyFee": 1.99,
          "numberOfInstallments": [
            12,
            24
          ],
          "daysUntilDisbursement": 7,
          "monthsUntilFirstDueDate": 1,
          "creditOperationType": "CCB",
          "rebates": [
            {
              "feeType": "first_loan",
              "amountType": "percentage",
              "amount": 0.2,
              "description": "Tarifa de cadastro",
              "minAmount": 200,
              "maxAmount": 2000
            },
            {
              "feeType": "all_loans",
              "amountType": "absolute",
              "amount": 200,
              "description": "Tarifa de cadastro"
            }
          ],
          "insurance": {
            "amount": 0,
            "fee": 1.73,
            "type": "required",
            "number": "123456",
            "insurer": "Cia de Seguros"
          }
        }
      },
      "documents": {
        "toRequest": [
          {
            "purpose": "account_requirement",
            "name": "crédito consignado",
            "owner": "customer",
            "expireInDays": 30
          }
        ]
      },
      "disbursement": "custom"
    }