Criar produto

POST /v1/products

Cria um novo produto.

Request

Query Parameters

expand string

Expande as referências.

Pode ser um valor único ou uma lista separada por vírgula (csv) de referências retornadas neste endpoint.

Example: data.loan

fields string

Permite especificar quais campos devem ser incluídos ou excluídos na resposta. Utilize o nome do campo para incluí-lo, ou prefixe o nome com um sinal de menos (-) para excluí-lo. Pode ser um valor único ou uma lista separada por vírgula(csv). Funciona para campos expandidos.

Esteja ciente de que especificar um campo para inclusão, terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Importante: Não é permitido combinar inclusões e exclusões na mesma requisição. Uma tentativa de fazê-lo resultará em um erro.

Examples:

inclusao
exclusao

Retorna apenas os campos `id` e `createdAt`.

Example: id,createdAt

Retorna todos os campos, exceto `id`.

Example: -id

Header Parameters

Idempotency-Key string

Chave única de idempotência para evitar duplicação de requisições.

Example: 5f92f01728e009f403d8502e

base39-external-client-id string

Chave de identificação do cliente externo. Utilizada para identificar o cliente que está realizando a requisição.

application/json

Body

slug stringrequired

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

Example: consignado

status string

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

Possible values: [active, inactive]

Default value: active

name stringrequired

Nome do produto que será exibido aos usuários

Example: Empréstimo consignado

description string

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

image string

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

title string

Título identificador do passo.

type string

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

Configuração do responsável pela assinatura.

type string

Tipo responsável pela assinatura.

Possible values: [operator, customer]

role string

Papel assumido.

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

Example: approver

Tipo de documento para verificação.

purpose string

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]

Configuração para validação de employment.

createdBy string

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

Possible values: [customer, operator]

Configuração para realizar a request customizável.

url stringrequired

Url a ser chamada.

Example: https://api.example.com

headers object

Valor do header Authorization

Configuração para criar documentos.

documents

object[]

Documentos criados após a criação do empréstimo, exemplos: ccb, seguro, etc…

Array [

purpose string

Possible values: [ccb, signature, insurance]

engine

object

type string

Template engine usado para gerar documentos.

Possible values: [google]

options

object

template string

Template utilizado no engine para gerar o documento.

]

Configuração de integração com a unico.io.

minScore number

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

Tipo de anexos para verificação.

purpose string[]

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

needs string[]

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

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 [

action string

Possible values: [void_loan, cancel_loan]

Example: ["void_loan"]

description string

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 [

action string

Possible values: [mark_loan_as_pending]

Example: ["mark_loan_as_pending"]

description string

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 [

quantityAllowed number

Número de empréstimos permitidos.

status string[]

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 [

title string

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

content string

Conteúdo da condição.

]

refin

object

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

minDays number

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

maxAge number

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

Example: 65

minAge number

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

Example: 18

minimumWage number

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.

amount number

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

daysToStart integer

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.

amount number

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

daysToStart integer

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

Example: 1

allowOverduePayment boolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue

object

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

type string

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

amount number

Dia exato ou a quantidade de dias.

Possible values: >= 1 and <= 28

Example: 1

updateInvoiceItemOnInsert boolean

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

type string

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

url string

headers object

metadata object

maxLoanAmount number

Valor máximo da solicitação de empréstimo.

Example: 10000

minLoanAmount number

Valor mínimo da solicitação de empréstimo.

Example: 200

maxNumberOfInstallments integer

Quantidade máximo de parcelas.

Example: 48

minNumberOfInstallments integer

Quantidade mínima de parcelas.

Example: 6

maxInstallmentValue integer

Valor máximo de cada parcela.

Example: 5000

minInstallmentValue integer

Valor mínimo de cada parcela.

Example: 0

offer

type string

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

monthlyFee number

Taxa de juros mensal

Example: 1.99

numberOfInstallments integer[]

Opções de parcelas

Example: [12,24]

daysUntilDisbursement integer

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

Example: 7

monthsUntilFirstDueDate integer

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

Example: 1

creditOperationType string

Tipo da operação de crédito.

Example: CCB

rebates

object[]

Array [

anyOf

RebatePercentage
RebateAbsolute

Detalhes das taxas de um empréstimo.

feeType stringrequired

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

amountType stringrequired

Tipo do valor a ser cobrado.

Possible values: [percentage]

Example: percentage

amount doublerequired

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

Example: 0.2

description stringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

minAmount number

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

Example: 200

maxAmount number

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

Example: 2000

Detalhes das taxas de um empréstimo.

feeType stringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: all_loans

amountType stringrequired

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amount doublerequired

Valor da tarifa.

Example: 200

description stringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

]

insurance

object

amount number

Example: 0

fee number

Example: 1.73

type string

Possible values: [required, optional, uninsured]

Example: required

number string

Example: 123456

insurer string

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 [

purpose string

method string

Template engine usado para gerar documentos.

Possible values: [google]

methodData

object

template string

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 [

purpose string

name string

Nome do documento.

Example: crédito consignado

owner string

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

Possible values: [customer, operator]

Example: customer

expireInDays integer

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

Possible values: >= 1

Example: 30

]

disbursement string

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

Example: custom

metadata object

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.

Responses

Retorna o objeto Product se a criação for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos.

application/json

Schema
Example (from schema)

Schema

id string

Identificador exclusivo para o objeto.

Example: prod_5f92f01728e009f403d8502e

slug string

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

Example: consignado

status string

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

Possible values: [active, inactive]

Default value: active

name string

Nome do produto que será exibido aos usuários

Example: Empréstimo consignado

description string

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

image string

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

title string

Título identificador do passo.

type string

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

Configuração do responsável pela assinatura.

type string

Tipo responsável pela assinatura.

Possible values: [operator, customer]

role string

Papel assumido.

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

Example: approver

Tipo de documento para verificação.

purpose string

Propósito

Configuração para validação de employment.

createdBy string

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

Possible values: [customer, operator]

Configuração para realizar a request customizável.

url stringrequired

Url a ser chamada.

Example: https://api.example.com

headers object

Valor do header Authorization

Configuração para criar documentos.

documents

object[]

Documentos criados após a criação do empréstimo, exemplos: ccb, seguro, etc…

Array [

purpose string

Possible values: [ccb, signature, insurance]

engine

object

type string

Template engine usado para gerar documentos.

Possible values: [google]

options

object

template string

Template utilizado no engine para gerar o documento.

]

Configuração de integração com a unico.io.

minScore number

Possible values: >= -100 and <= 100

Example: 70

Tipo de anexos para verificação.

purpose string[]

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

needs string[]

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

slug string

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 [

action string

Possible values: [void_loan, cancel_loan]

Example: ["void_loan"]

description string

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 [

action string

Possible values: [mark_loan_as_pending]

Example: ["mark_loan_as_pending"]

description string

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 [

quantityAllowed number

Número de empréstimos permitidos.

status string[]

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 [

title string

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

content string

Conteúdo da condição.

]

refin

object

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

minDays number

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

maxAge number

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

Example: 65

minAge number

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

Example: 18

minimumWage number

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.

amount number

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

daysToStart integer

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.

amount number

Example: 0.01

daysToStart integer

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

Example: 1

allowOverduePayment boolean

Permite pagamento da fatura após o vencimento.

Example: true

daysUntilDue

object

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

type string

Possible values: [absolute]

Example: absolute

amount number

Dia exato ou a quantidade de dias.

Possible values: >= 1 and <= 28

Example: 1

updateInvoiceItemOnInsert boolean

Example: true

products

object

Configurações de produtos

eligibility

object

type string

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

url string

headers object

metadata object

maxLoanAmount number

Valor máximo da solicitação de empréstimo.

Example: 10000

minLoanAmount number

Valor mínimo da solicitação de empréstimo.

Example: 200

maxNumberOfInstallments integer

Quantidade máximo de parcelas.

Example: 48

minNumberOfInstallments integer

Quantidade mínima de parcelas.

Example: 6

maxInstallmentValue integer

Valor máximo de cada parcela.

Example: 5000

minInstallmentValue integer

Valor mínimo de cada parcela.

Example: 0

offer

type string

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

monthlyFee number

Taxa de juros mensal

Example: 1.99

numberOfInstallments integer[]

Opções de parcelas

Example: [12,24]

daysUntilDisbursement integer

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

Example: 7

monthsUntilFirstDueDate integer

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

Example: 1

creditOperationType string

Tipo da operação de crédito.

Example: CCB

rebates

object[]

Array [

anyOf

RebatePercentage
RebateAbsolute

Detalhes das taxas de um empréstimo.

feeType stringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: first_loan

amountType stringrequired

Tipo do valor a ser cobrado.

Possible values: [percentage]

Example: percentage

amount doublerequired

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

Example: 0.2

description stringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

minAmount number

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

Example: 200

maxAmount number

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

Example: 2000

Detalhes das taxas de um empréstimo.

feeType stringrequired

Tipo da tarifa.

Possible values: [all_loans, first_loan, except_first_loan]

Example: all_loans

amountType stringrequired

Tipo do valor a ser cobrado.

Possible values: [absolute]

Example: absolute

amount doublerequired

Valor da tarifa.

Example: 200

description stringrequired

Descrição para a tarifa.

Example: Tarifa de cadastro

]

insurance

object

amount number

Example: 0

fee number

Example: 1.73

type string

Possible values: [required, optional, uninsured]

Example: required

number string

Example: 123456

insurer string

Example: Cia de Seguros

documents

object

toCreate

object[]

deprecated

Array [

purpose string

method string

Template engine usado para gerar documentos.

Possible values: [google]

methodData

object

template string

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 [

purpose string

name string

Nome do documento.

Example: crédito consignado

owner string

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

Possible values: [customer, operator]

Example: customer

expireInDays integer

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

Possible values: >= 1

Example: 30

]

disbursement string

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

Example: custom

metadata object

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.

createdAt date-time

Data de criação do objeto

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

updatedAt date-time

Data de alteração do objeto

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

deleted boolean

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

Default value: false

Example: false

createdBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

updatedBy

object

clientId string

Identificador do cliente que criou a assinatura.

Example: client_identifier

externalClientId string

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.

app string

Nome da aplicação que criou a assinatura.

Example: backoffice

{
  "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"
      },
      "offer": {
        "type": "online",
        "options": {}
      },
      "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"
  }
}

Criar produto

/v1/products

Request​

Query Parameters

Header Parameters

Body

Responses​

Request

Responses