Product

Este objeto representa um produto.

idstring

Identificador exclusivo para o objeto.

Example: prod_5f92f01728e009f403d8502e

slugstring

Deve ser uma string sem espaços ou caracteres especiais. É utilizada para agrupar produtos do mesmo tipo.

Example: consignado

statusstring

Status do produto. Se inativo, não será exibido no Portal do Cliente.

Possible values: [active, inactive]

Default value: active

namestring

Nome do produto que será exibido aos usuários

Example: Empréstimo consignado

descriptionstring

Pequena descrição sobre o produto. Pode ser exibido na página inicial do Portal do Cliente.

imagestring

Imagem do produto. Pode ser exibido na página inicial do Portal do Cliente.

settings object

steps

property name* SettingsSteps

Configurações do modo passo a passo

titlestring

Título identificador do passo.

typestring

Tipo identificador do passo.

Possible values: [signature, disburse, document_verification, pass, valid_employment, custom_request, create_documents, attachments_to_request, unico]

methodData object

Objeto que contém dados específicos para o tipo de etapa. Por exemplo, se a etapa for do tipo signature, este objeto conterá os dados necessários para a assinatura do documento.

anyOf

typestring

Tipo responsável pela assinatura.

Possible values: [operator, customer]

rolestring

Papel assumido.

Possible values: [approver, financial, administrator, backoffice]

Example: approver

purposestring

Propósito

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]

createdBystring

Definição de quem deveria ter criado o employment.

Possible values: [customer, operator]

urlstringrequired

Url a ser chamada.

Example: https://api.example.com

headersobject

Valor do header Authorization

minScorenumber

Score mínimo aceito na validação de identidade. Esta propriedade somente será utilizada se o resultado da validação da biometria UNICO não for conclusiva. Para maiores informações, consulte o funcionamento do score.

Possible values: >= -100 and <= 100

Example: 70

purposestring[]

Possible values: [account_requirement, identity_document, additional_verification, selfie, identity_document_front, identity_document_back, pay_stub, proof_of_address]

needsstring[]

Array de dependência (slugs) entre os passos necessarios para que esse seja executado.

slugstring

Identificador único do passo.

hooks object

Definição de hooks da esteira.

onFailure object[]

Lista de ações que serão executadas se um passo da esteira falhar.

Array [

actionstring

Possible values: [void_loan, cancel_loan]

Example: ["void_loan"]

descriptionstring

Example: Ação de cancelamento de empréstimo.

]

onStart object[]

Lista de ações que serão executadas ao iniciar um passo da esteira.

Array [

actionstring

Possible values: [mark_loan_as_pending]

Example: ["mark_loan_as_pending"]

descriptionstring

Example: Marcar o empréstimo como pendente.

]

loans object

Configurações de empréstimos

concurrency object[]

Configurações referentes às limitações na criação de loans simultâneos.

Array [

quantityAllowednumber

Número de empréstimos permitidos.

statusstring[]

Status a ser considerado na limitação da criação dos empréstimos.

Possible values: [open, disbursed, disbursing, repaid, void, canceled, expired, pending, draft]

]

conditions object[]

Termos e Condições do empréstimo.

Array [

titlestring

Texto identificador da condição de empréstimos.

contentstring

Conteúdo da condição.

]

refin object

Configurações referentes à refinanciamento de empréstimos.

minDaysnumber

Número mínimo de dias necessário para que uma proposta possa ser refinanciada, contado a partir da criação da proposta.

maxAgenumber

Idade máxima do cliente para solicitar um empréstimo.

Example: 65

minAgenumber

Idade mínima do cliente para solicitar um empréstimo.

Example: 18

minimumWagenumber

Piso salarial necessário para solicitar um empréstimo.

Example: 2500

invoices object

Configurações de faturas

payOff object

Configurações de quitação.

fine object

Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amountnumber

Valor da multa representado em base decimal. A Multa é cobrada uma única vez independente do número de dias de vencimento. O valor máximo para multa é de 2% (0.02).

Example: 0.02

daysToStartinteger

Quantidade de dias após o vencimento que a multa começará a incidir.

Example: 1

interest object

Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.

amountnumber

Valor de juros representado em base decimal e ao mês. O valor máximo permitido é 1% (0.01). Os Juros são definidos ao mês, mas calculo para o pagamento após o vencimento converte para juros ao dia e aplica a quantidade de dias em atraso.

Example: 0.01

daysToStartinteger

Quantidade de dias após o vencimento que juro começará a incidir.

Example: 1

allowOverduePaymentboolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue object

Definição de regras para o fechamento da fatura.

typestring

Tipo de dias. Absoluto representa uma composição de um determinado dia somado ao valor definido em amount. O resultado dessa soma será considerado a data para fechamento da fatura. Exemplo: dia 5 + amount (3) 08/mês/ano.

Possible values: [absolute]

Example: absolute

amountnumber

Dia exato ou a quantidade de dias.

Possible values: >= 1 and <= 28

Example: 1

updateInvoiceItemOnInsertboolean

Define se no ato de criar o item de fatura será calculado automaticamente descontos/multa para a fatura em contexto. Os valores base usados nesse cálculos são originados de payOff, customerRecurring ou companyRecurring.

Example: true

products object

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

dynamic
mock

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

mock
offline
online

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

RebatePercentage
RebateAbsolute

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

feeTypestringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: all_loans

amountTypestringrequired

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amountdoublerequired

Valor da tarifa.

Example: 200

descriptionstringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

]

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

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

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

metadataobject

Conjunto de pares de valores-chave que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado.

createdAtdate-time

Data de criação do objeto

Example: 2023-08-25T22:38:41.134Z

updatedAtdate-time

Data de alteração do objeto

Example: 2023-08-25T22:38:41.134Z

deletedboolean

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Default value: false

Example: false

createdBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy object

clientIdstring

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientIdstring

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição. Populado pelo campo enviado no header base39-external-client-id.

appstring

Nome da aplicação que criou a assinatura.

Example: backoffice

Product
{
  "id": "prod_5f92f01728e009f403d8502e",
  "slug": "consignado",
  "status": "active",
  "name": "Empréstimo consignado",
  "description": "string",
  "image": "string",
  "settings": {
    "loans": {
      "concurrency": [
        {
          "quantityAllowed": 0,
          "status": [
            "open"
          ]
        }
      ],
      "conditions": [
        {
          "title": "string",
          "content": "string"
        }
      ],
      "refin": {
        "minDays": 0
      },
      "maxAge": 65,
      "minAge": 18,
      "minimumWage": 2500
    },
    "invoices": {
      "payOff": {
        "fine": {
          "amount": 0.02,
          "daysToStart": 1
        },
        "interest": {
          "amount": 0.01,
          "daysToStart": 1
        },
        "allowOverduePayment": true,
        "daysUntilDue": {
          "type": "absolute",
          "amount": 1
        },
        "updateInvoiceItemOnInsert": true
      }
    },
    "products": {
      "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"
    }
  },
  "metadata": {},
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  },
  "updatedBy": {
    "clientId": "client_identifier",
    "externalClientId": "string",
    "app": "backoffice"
  }
}