Settings

Este objeto representa as configurações.

disbursements

object

Show child attributes

disbursements.{key}

object

Configurações de desembolso.

Show child attributes

disbursements.{key}.type

enum<string>

required

Available options:

qitech,

bv,

custom,

mock

disbursements.{key}.credentials

object

• QITech
• BV
• Custom

Show child attributes

disbursements.{key}.credentials.apiKey

string

required

Chave de acesso à api do parceiro de bancarização.

disbursements.{key}.credentials.ccbPrefix

string

required

Prefixo da CCB.

disbursements.{key}.credentials.privateKey

string

required

Chave privada do parceiro de bancarização.

disbursements.{key}.credentials.publicKey

string

required

Chave pública do parceiro de bancarização.

disbursements.{key}.credentials.url

string

required

URL do parceiro de bancarização.

disbursements.{key}.credentials.passphrase

string

Frase secreta.

disbursements.{key}.disbursementDay

enum<string>

Available options:

sameDay,

nextWorkDay

disbursements.{key}.supportedPaymentMethods

enum<string>[]

Available options:

invoice,

boleto,

paymentMethod.pix,

paymentMethod.bankAccount

domains

object

Configurações de domínios customizados

Show child attributes

domains.backoffice

string

URL do Backoffice.

domains.company

string

URL do Portal Empresa.

domains.customer

string

URL do Portal Cliente.

employments

object

Configurações de vínculos empregatícios

Show child attributes

employments.expireInDays

integer

Quantidade de dias para expirar o vínculo empregatício.

flags

object

Configurações de flags.

Show child attributes

flags.showCancelButtonBeforeDisbursement

boolean

Mostrar o botão de cancelar antes do desembolso.

invoices

object

Configurações de faturas

Show child attributes

invoices.autoMoneyRelocation

boolean

Se verdadeiro, o sistema irá fazer o remanejo automático de dinheiro entre as parcelas que possuem valor pago excedente.

invoices.companyRecurring

object

Configuração de recorrência de fatura.

Show child attributes

invoices.companyRecurring.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

invoices.companyRecurring.create

object

Definição de regras para geração de fatura.

Show child attributes

invoices.companyRecurring.create.autoCreate

boolean

Define se a fatura deve ser criada automaticamente.

invoices.companyRecurring.create.cutoffDay

number

invoices.companyRecurring.daysUntilDue

object

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

Show child attributes

invoices.companyRecurring.daysUntilDue.amount

number

Dia do mês para fechamento da fatura.

invoices.companyRecurring.daysUntilDue.type

enum<string>

Tipo de dias usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.

Available options:

static

invoices.companyRecurring.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

invoices.companyRecurring.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).

invoices.companyRecurring.fine.daysToStart

integer

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

invoices.companyRecurring.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

invoices.companyRecurring.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.

invoices.companyRecurring.interest.daysToStart

integer

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

invoices.companyRecurring.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.

invoices.customerRecurring

object

Configuração de recorrência de fatura.

Show child attributes

invoices.customerRecurring.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

invoices.customerRecurring.create

object

Definição de regras para geração de fatura.

Show child attributes

invoices.customerRecurring.create.autoCreate

boolean

Define se a fatura deve ser criada automaticamente.

invoices.customerRecurring.daysUntilDue

object

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

Show child attributes

invoices.customerRecurring.daysUntilDue.amount

number

Quantidade de dias para fechamento da fatura.

invoices.customerRecurring.daysUntilDue.type

enum<string>

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

Available options:

absolute

invoices.customerRecurring.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

invoices.customerRecurring.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).

invoices.customerRecurring.fine.daysToStart

integer

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

invoices.customerRecurring.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

invoices.customerRecurring.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.

invoices.customerRecurring.interest.daysToStart

integer

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

invoices.customerRecurring.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.

invoices.payOff

object

Configurações de quitação.

Show child attributes

invoices.payOff.allowOverduePayment

boolean

Permite pagamento da fatura após o vencimento.

invoices.payOff.daysUntilDue

object

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

Show child attributes

invoices.payOff.daysUntilDue.amount

number

Dia exato ou a quantidade de dias.

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

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

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

invoices.payOff.fine.daysToStart

integer

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

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

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.

invoices.payOff.interest.daysToStart

integer

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

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.

loans

object

Configurações de empréstimos

Show child attributes

loans.concurrency

object[]

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

Show child attributes

loans.concurrency.quantityAllowed

number

Número de empréstimos permitidos.

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

loans.conditions

object[]

Termos e Condições do empréstimo.

Show child attributes

loans.conditions.content

string

Conteúdo da condição.

loans.conditions.title

string

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

locales

object

Estes são textos personalizáveis da aplicação, que aceitam campos chave-valor. É importante notar que nesta página de documentação, você pode criar até três níveis de objetos aninhados. No entanto, ao realizar chamadas fora desta página de documentação, o suporte é estendido para além de três níveis.

Show child attributes

locales.{key}

object

Show child attributes

locales.{key}.{key}

object

notifications

object

Configurações de serviços provedores de notificações.

Show child attributes

notifications.email

object

Configurações do provedor de notificações via e-mail.

Show child attributes

notifications.email.config

object

Objeto para definir a configuração para utilização do provedor de email.

Show child attributes

notifications.email.config.email

string

E-mail utilizado para o envio.

notifications.email.config.host

string

Nome do host ou endereço IP ao qual se conectar.

notifications.email.config.password

string

Senha de usuário do servidor SMTP.

notifications.email.config.port

number

Porta de conexão SMTP.

notifications.email.config.username

string

Nome de usuário do servidor SMTP.

notifications.email.provider

string

Provedor utilizado para envio de email.

notifications.sms

object

Configurações do provedor de notificações via SMS.

Show child attributes

notifications.sms.config

object

Objeto para definir a configuração para utilização do provedor de SMS.

Show child attributes

notifications.sms.config.basePath

string

Url base do provedor.

notifications.sms.config.token

string

Token para conexão com a infobip.

notifications.sms.provider

string

Provedor utilizado para envio de SMS.

notifications.whatsapp

object

Configurações do provedor de notificações via WhatsApp.

Show child attributes

notifications.whatsapp.config

object

Objeto para definir a configuração para utilização do provedor de mensagens via WhatsApp.

Show child attributes

notifications.whatsapp.config.account

string

Conta da twilio.

notifications.whatsapp.config.sender

string

Número de telefone base para envio da mensagem.

notifications.whatsapp.config.token

string

Token para conexão com a twilio.

notifications.whatsapp.provider

string

Provedor utilizado para envio de mensagens via WhatsApp.

queues

object[]

Configurações de fila

Show child attributes

queues.name

string

Nome da fila

queues.query

string

Uma string de busca que permite criar filtros personalizados. Filtros permitidos customer, company, id, status, attachment, external_id e created_at. Para os campos que são string ou um conjunto de string separadas por vírgula o único comparador válido é :. Para campos do tipo data ou números são permitidos os comparadores =, >, <, >= e <=. É possível utilizar o operador AND para concatenar mais de uma query e o operador OR. Veja mais em Pesquisa

recaptcha

object

Configurações do recaptcha. Estas configurações não são utilizadas em rotinas de Core, cabendo ao Core apenas responsabilidade de persistência e disponilidade de dados.

Show child attributes

recaptcha.siteKey

string

Segredo para utilizar o recaptcha

steps

object

Configurações de fluxos em modo passo a passo do empréstimos.

Show child attributes

steps.{key}

object

Configurações do modo passo a passo

Show child attributes

steps.{key}.hooks

object

Definição de hooks da esteira.

Show child attributes

steps.{key}.hooks.onFailure

enum<string>[]

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

Available options:

void_loan,

cancel_loan

steps.{key}.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

steps.{key}.methodData.schema

object

Configuração do responsável pela assinatura.

• signature
• document_verification
• valid_employment
• custom_request
• create_documents
• unico
• attachments_to_request
• unico check

Show child attributes

steps.{key}.methodData.schema.role

enum<string>

Papel assumido.

Available options:

approver,

financial,

administrator,

backoffice

steps.{key}.methodData.schema.type

enum<string>

Tipo responsável pela assinatura.

Available options:

operator,

customer

steps.{key}.needs

string[]

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

steps.{key}.onStart

enum<string>[]

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

Available options:

mark_loan_as_pending

steps.{key}.slug

string

Identificador único do passo.

steps.{key}.title

string

Título identificador do passo.

steps.{key}.type

enum<string>

Tipo identificador do passo.

Available options:

signature,

disburse,

document_verification,

pass,

valid_employment,

custom_request,

create_documents,

attachments_to_request,

unico,

unico_check

validations

object

Configurações de validadores.

Show child attributes

validations.pix

object

Configuração do provedor de PIX.

Show child attributes

validations.pix.credentials

object

Definição de credênciais do provedor de serviço PIX.

• QITech
• Custom
• Mock

Show child attributes

validations.pix.credentials.apiKey

string

required

Chave de acesso à api do parceiro de bancarização.

validations.pix.credentials.ccbPrefix

string

required

Prefixo da CCB.

validations.pix.credentials.privateKey

string

required

Chave privada do parceiro de bancarização.

validations.pix.credentials.publicKey

string

required

Chave pública do parceiro de bancarização.

validations.pix.credentials.url

string

required

URL do parceiro de bancarização.

validations.pix.credentials.passphrase

string

Frase secreta.

validations.pix.type

enum<string>

Tipo das credenciais do provedor de PIX.

Available options:

qitech,

custom,

mock