Criar produto

Cria um novo produto.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

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

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.

fields

string[]

Uma lista separada por vírgulas de atributos a serem incluídos na resposta. Isso pode ser usado para solicitar campos que normalmente não são retornados em uma resposta padrão.

Esteja ciente de que especificar este parâmetro terá o efeito que nenhum dos campos padrão seja retornado na resposta, a menos que seja explicitamente especificado.

Body

application/json

Criar um produto

name

string

required

Nome do produto que será exibido aos usuários

slug

string

required

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

description

string

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

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.

settings

object

Show child attributes

settings.invoices

object

Configurações de faturas

Show child attributes

settings.invoices.payOff

object

Configurações de quitação.

Show child attributes

settings.invoices.payOff.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

settings.invoices.payOff.daysUntilDue

object

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

Show child attributes

settings.invoices.payOff.daysUntilDue.amount

number

Dia exato ou a quantidade de dias.

settings.invoices.payOff.daysUntilDue.type

enum<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.

Available options:

absolute

settings.invoices.payOff.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.

Show child attributes

settings.invoices.payOff.fine.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).

settings.invoices.payOff.fine.daysToStart

integer

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

settings.invoices.payOff.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.

Show child attributes

settings.invoices.payOff.interest.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.

settings.invoices.payOff.interest.daysToStart

integer

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

settings.invoices.payOff.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.

settings.loans

object

Configurações de empréstimos

Show child attributes

settings.loans.concurrency

object[]

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

Show child attributes

settings.loans.concurrency.quantityAllowed

number

Número de empréstimos permitidos.

settings.loans.concurrency.status

enum<string>[]

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

Available options:

open,

disbursed,

disbursing,

repaid,

void,

canceled,

expired,

pending

settings.loans.conditions

object[]

Termos e Condições do empréstimo.

Show child attributes

settings.loans.conditions.content

string

Conteúdo da condição.

settings.loans.conditions.title

string

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

settings.loans.maxAge

number

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

settings.loans.minAge

number

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

settings.loans.minimumWage

number

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

settings.products

object

Configurações de produtos

Show child attributes

settings.products.disbursement

string

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

settings.products.documents

object

Show child attributes

settings.products.documents.toCreate

object[]

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

Show child attributes

settings.products.documents.toCreate.method

enum<string>

Template engine usado para gerar documentos.

Available options:

google

settings.products.documents.toCreate.methodData

object

Show child attributes

settings.products.documents.toCreate.purpose

enum<string>

Available options:

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

settings.products.documents.toRequest

object[]

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

Show child attributes

settings.products.documents.toRequest.expireInDays

integer

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

Required range: x > 1

settings.products.documents.toRequest.name

string

Nome do documento.

settings.products.documents.toRequest.owner

enum<string>

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

Available options:

customer,

operator

settings.products.documents.toRequest.purpose

enum<string>

Available options:

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

settings.products.eligibility

object

Show child attributes

settings.products.eligibility.options

object

• dynamic
• mock

Show child attributes

settings.products.eligibility.options.headers

object

settings.products.eligibility.options.metadata

object

settings.products.eligibility.options.url

string

settings.products.eligibility.type

enum<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.

Available options:

static,

dynamic,

mock

settings.products.offer

object

Show child attributes

settings.products.offer.options

object

• mock
• offline
• online

Show child attributes

settings.products.offer.options.creditOperationType

string

Tipo da operação de crédito.

settings.products.offer.options.daysUntilDisbursement

integer

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

settings.products.offer.options.insurance

object

Show child attributes

settings.products.offer.options.monthlyFee

number

Taxa de juros mensal

settings.products.offer.options.monthsUntilFirstDueDate

integer

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

settings.products.offer.options.numberOfInstallments

integer[]

Opções de parcelas

settings.products.offer.options.rebates

object[]

Lista de valores adicionais do empréstimo

Show child attributes

settings.products.offer.type

enum<string>

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

Available options:

online,

offline,

mock

settings.steps

object

Configurações do modo passo a passo

Show child attributes

settings.steps.hooks

object

Definição de hooks da esteira.

Show child attributes

settings.steps.hooks.onFailure

enum<string>[]

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

Available options:

void_loan,

cancel_loan

settings.steps.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.

Show child attributes

settings.steps.methodData.schema

object

Configuração do responsável pela assinatura.

• signature
• document_verification
• valid_employment
• custom_request
• unico
• attachments_to_request

Show child attributes

settings.steps.methodData.schema.role

enum<string>

Papel assumido.

Available options:

approver,

financial,

administrator,

backoffice

settings.steps.methodData.schema.type

enum<string>

Tipo responsável pela assinatura.

Available options:

operator,

customer

settings.steps.needs

string[]

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

settings.steps.onStart

enum<string>[]

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

Available options:

mark_loan_as_pending

settings.steps.title

string

Título identificador do passo.

settings.steps.type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

attachments_to_request

status

enum<string>

default:

active

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

Available options:

active,

inactive

Response

201 - application/json

Este objeto representa um produto.

createdAt

string

Data de criação do objeto

deleted

boolean

default:

false

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

description

string

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

id

string

Identificador exclusivo para o objeto.

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.

name

string

Nome do produto que será exibido aos usuários

settings

object

Show child attributes

settings.invoices

object

Configurações de faturas

Show child attributes

settings.invoices.payOff

object

Configurações de quitação.

Show child attributes

settings.invoices.payOff.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

settings.invoices.payOff.daysUntilDue

object

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

Show child attributes

settings.invoices.payOff.daysUntilDue.amount

number

Dia exato ou a quantidade de dias.

settings.invoices.payOff.daysUntilDue.type

enum<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.

Available options:

absolute

settings.invoices.payOff.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.

Show child attributes

settings.invoices.payOff.fine.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).

settings.invoices.payOff.fine.daysToStart

integer

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

settings.invoices.payOff.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.

Show child attributes

settings.invoices.payOff.interest.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.

settings.invoices.payOff.interest.daysToStart

integer

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

settings.invoices.payOff.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.

settings.loans

object

Configurações de empréstimos

Show child attributes

settings.loans.concurrency

object[]

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

Show child attributes

settings.loans.concurrency.quantityAllowed

number

Número de empréstimos permitidos.

settings.loans.concurrency.status

enum<string>[]

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

Available options:

open,

disbursed,

disbursing,

repaid,

void,

canceled,

expired,

pending

settings.loans.conditions

object[]

Termos e Condições do empréstimo.

Show child attributes

settings.loans.conditions.content

string

Conteúdo da condição.

settings.loans.conditions.title

string

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

settings.loans.maxAge

number

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

settings.loans.minAge

number

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

settings.loans.minimumWage

number

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

settings.products

object

Configurações de produtos

Show child attributes

settings.products.disbursement

string

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

settings.products.documents

object

Show child attributes

settings.products.documents.toCreate

object[]

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

Show child attributes

settings.products.documents.toCreate.method

enum<string>

Template engine usado para gerar documentos.

Available options:

google

settings.products.documents.toCreate.methodData

object

Show child attributes

settings.products.documents.toCreate.purpose

enum<string>

Available options:

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

settings.products.documents.toRequest

object[]

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

Show child attributes

settings.products.documents.toRequest.expireInDays

integer

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

Required range: x > 1

settings.products.documents.toRequest.name

string

Nome do documento.

settings.products.documents.toRequest.owner

enum<string>

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

Available options:

customer,

operator

settings.products.documents.toRequest.purpose

enum<string>

Available options:

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

settings.products.eligibility

object

Show child attributes

settings.products.eligibility.options

object

• dynamic
• mock

Show child attributes

settings.products.eligibility.options.headers

object

settings.products.eligibility.options.metadata

object

settings.products.eligibility.options.url

string

settings.products.eligibility.type

enum<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.

Available options:

static,

dynamic,

mock

settings.products.offer

object

Show child attributes

settings.products.offer.options

object

• mock
• offline
• online

Show child attributes

settings.products.offer.options.creditOperationType

string

Tipo da operação de crédito.

settings.products.offer.options.daysUntilDisbursement

integer

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

settings.products.offer.options.insurance

object

Show child attributes

settings.products.offer.options.monthlyFee

number

Taxa de juros mensal

settings.products.offer.options.monthsUntilFirstDueDate

integer

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

settings.products.offer.options.numberOfInstallments

integer[]

Opções de parcelas

settings.products.offer.options.rebates

object[]

Lista de valores adicionais do empréstimo

Show child attributes

settings.products.offer.type

enum<string>

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

Available options:

online,

offline,

mock

settings.steps

object

Configurações do modo passo a passo

Show child attributes

settings.steps.hooks

object

Definição de hooks da esteira.

Show child attributes

settings.steps.hooks.onFailure

enum<string>[]

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

Available options:

void_loan,

cancel_loan

settings.steps.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.

Show child attributes

settings.steps.methodData.schema

object

Configuração do responsável pela assinatura.

• signature
• document_verification
• valid_employment
• custom_request
• unico
• attachments_to_request

Show child attributes

settings.steps.methodData.schema.role

enum<string>

Papel assumido.

Available options:

approver,

financial,

administrator,

backoffice

settings.steps.methodData.schema.type

enum<string>

Tipo responsável pela assinatura.

Available options:

operator,

customer

settings.steps.needs

string[]

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

settings.steps.onStart

enum<string>[]

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

Available options:

mark_loan_as_pending

settings.steps.slug

string

Identificador único do passo.

settings.steps.title

string

Título identificador do passo.

settings.steps.type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

attachments_to_request

slug

string

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

status

enum<string>

default:

active

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

Available options:

active,

inactive

updatedAt

string

Data de alteração do objeto