Atualizar configurações

POST 
/v1/settings

Atualiza as configurações.

Request

Header Parameters

Idempotency-Key string
Chave única de idempotência para evitar duplicação de requisições.
Example: 5f92f01728e009f403d8502e

application/json

Body

stepsobject

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

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

signature

Configuração do responsável pela assinatura.

typestring

Tipo responsável pela assinatura.

Possible values: [operator, customer]

rolestring

Papel assumido.

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

Example: approver

document_verification

Tipo de documento para verificação.

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]

valid_employment

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

createdBystring

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

Possible values: [customer, operator]

custom_request

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

urlstringrequired

Url a ser chamada.

Example: https://api.example.com

headersobject

Valor do header Authorization

create_documents

Configuração para criar documentos.

documents

object[]

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

Array [

purposestring

Possible values: [ccb, signature, insurance]

engine

object

typestring

Template engine usado para gerar documentos.

Possible values: [google]

options

object

templatestring

Template utilizado no engine para gerar o documento.

]

unico

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

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

attachments_to_request

Tipo de anexos para verificação.

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.

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.

]

disbursements

object

insurance

object

comboIdstringrequired

Identificador do combo de produto.

productIdstringrequired

Identificador do produto.

maxAmountdoublerequired

Valor máximo de cobertura do seguro.

typestring

Tipo de conta bancária.

Possible values: [base39, client_account]

account

object

anyOf

client_account

holderNamestringrequired

O nome da pessoa ou empresa que possui a conta bancária.

holderDocumentstringrequired

O documento da entidade que detém a conta. Pode ser CPF ou CNPJ.

bankCodestringrequired

Código COMPE da Instituição Financeira.

branchstringrequired

A agência da conta bancária.

numberstringrequired

O número da conta bancária. Deve ser uma conta corrente ou conta poupança.

digitstringrequired

property name*

SettingsDisbursements

Configurações de desembolso.

typestringrequired

Possible values: [qitech, bv, custom, mock, banco_paulista]

credentials

object

anyOf

QITech

urlstringrequired

URL do parceiro de bancarização.

Example: https://api-auth.sandbox.qitech.app

apiKeystringrequired

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

Example: abcdef12345

privateKeystringrequired

Chave privada do parceiro de bancarização.

Example: -----BEGIN RSA PRIVATE KEY-----\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\n-----END RSA PRIVATE KEY-----

publicKeystringrequired

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

Example: -----BEGIN PUBLIC KEY-----\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\n-----END PUBLIC KEY-----

ccbPrefixstringrequired

Prefixo da CCB.

passphrasestring

Frase secreta.

BV

clientIdstringrequired

Client ID.

clientSecretstringrequired

Client Secret.

fetchRebatesboolean

incluir TC nas propostas da BV.

Custom

urlstringrequired

URL do fundo.

Example: https://api.example.com

headersobject

Valor do header Authorization

Banco Paulista

promoterstring

Promotora

Example: 9999

storeChainstring

Rede de Lojas

Example: 9999

storestring

Loja

Example: 9999

productstring

Produto

Example: 9999

planstring

Plano

Example: 9999

userstring

Nome de usuário

Example: New User

supportedPaymentMethodsstring[]

Possible values: [invoice, boleto, paymentMethod.pix, paymentMethod.bankAccount]

disbursementDaystring

Possible values: [sameDay, nextWorkDay]

flagsobject
Configurações de flags.
showCancelButtonBeforeDisbursementboolean
Mostrar o botão de cancelar antes do desembolso.
Example: true
automaticChargebackboolean
Reembolsar automaticamente valores pagos a mais pelos clientes
Example: true

notifications

object

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

email

object

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

providerstring

Provedor utilizado para envio de email.

Possible values: [default, test_only, smtp]

config

object

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

emailstring

E-mail utilizado para o envio.

hoststring

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

portnumber

Porta de conexão SMTP.

usernamestring

Nome de usuário do servidor SMTP.

passwordstring

Senha de usuário do servidor SMTP.

sms

object

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

providerstring

Provedor utilizado para envio de SMS.

Possible values: [test_only, infobip]

config

object

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

tokenstring

Token para conexão com a infobip.

basePathuri

Url base do provedor.

whatsapp

object

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

providerstring

Provedor utilizado para envio de mensagens via WhatsApp.

Possible values: [test_only, default, twilio]

config

object

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

accountstring

Conta da twilio.

tokenstring

Token para conexão com a twilio.

senderstring

Número de telefone base para envio da mensagem.

validations

object

Configurações de validadores.

pix

object

Configuração do provedor de PIX.

typestring

Tipo das credenciais do provedor de PIX.

Possible values: [qitech, custom, mock]

credentials

object

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

anyOf

QITech

Credênciais de QITech.

urlstringrequired

URL do parceiro de bancarização.

Example: https://api-auth.sandbox.qitech.app

apiKeystringrequired

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

Example: abcdef12345

privateKeystringrequired

Chave privada do parceiro de bancarização.

Example: -----BEGIN RSA PRIVATE KEY-----\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\n-----END RSA PRIVATE KEY-----

publicKeystringrequired

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

Example: -----BEGIN PUBLIC KEY-----\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\n-----END PUBLIC KEY-----

ccbPrefixstringrequired

Prefixo da CCB.

passphrasestring

Frase secreta.

Custom

Credênciais customizadas do provedor PIX.

urlstringrequired

URL do serviço provedor de PIX.

Example: https://api.example.com

headersobject

Par de chave-valor usado como cabeçalho do serviço de validação.

Example: Authorization: Bearer value

Mock

Credênciais de mock(objeto que imita comportamento) do provedor PIX.

urlstring

URL do serviço provedor de PIX.

Example: https://api.base39.io/v1/mocks

headersobject

Par de chave-valor usado como cabeçalho do serviço de validação.

Example: Authorization: Bearer value
loansobject

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.

expireInDaysnumber

Número de dias para expiração de um empréstimo, contando a partir da data de criação.

invoicesobject

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

customerRecurring

object

Configuração de recorrência de fatura.

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

Possible values: [absolute]

Example: absolute

amountnumber

Quantidade de dias para fechamento da fatura.

Possible values: >= 1 and <= 28

Example: 10

create

object

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

autoCreateboolean

Define se a fatura deve ser criada automaticamente.

Example: true

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: false

companyRecurring

object

Configuração de recorrência de fatura.

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 usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.

Possible values: [static]

Example: static

amountnumber

Dia do mês para fechamento da fatura.

Possible values: >= 1 and <= 28

Example: 10

create

object

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

cutoffDaynumber

Define o dia limite para a edição de uma fatura, antes que ela seja fechada.

Example: 25

autoCreateboolean

Define se a fatura deve ser criada automaticamente.

Example: true

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: false

autoMoneyRelocationboolean

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

localesobject
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.
property name*
object

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.

siteKeystring

Segredo para utilizar o recaptcha

employments

object

Configurações de vínculos empregatícios

expireInDaysinteger

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

Example: 30
domainsobject

Configurações de domínios customizados

companystring

URL do Portal Empresa.

customerstring

URL do Portal Cliente.

backofficestring

URL do Backoffice.

queuesobject[]

Configurações de fila

Array [

namestring

Nome da fila

Example: Fila de propostas

querystring

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

Example: status:open OR status:pending AND customer.id:`${customer.id}` AND created_at<`${date}` AND company.document:`${company.document}`

]

installments

object

Configurações de parcelas.

dueDate

object

Configuração de data de vencimento.

typestring

Tipo de data de vencimento. absolute representa o dia exato do mês, static representa o dia + amount.

Possible values: [absolute, static]

amountinteger

Quantidade de dias para vencimento.

Example: 10

graceDate

object

Configuração de data de carência.

typestring

Tipo de data de carência.

Possible values: [days, months]

amountinteger

Quantidade para carência.

Example: 10

skipInstallmentsinteger

Quantidade de parcelas que serão desconsideradas até a cobrança.

Example: 1

Responses

201

Retorna o objeto Settings se a atualização for bem-sucedida; caso contrário, retorna um erro.

application/json

Schema

Schema

steps

object

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

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

signature

Configuração do responsável pela assinatura.

typestring

Tipo responsável pela assinatura.

Possible values: [operator, customer]

rolestring

Papel assumido.

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

Example: approver

document_verification

Tipo de documento para verificação.

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]

valid_employment

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

createdBystring

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

Possible values: [customer, operator]

custom_request

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

urlstringrequired

Url a ser chamada.

Example: https://api.example.com

headersobject

Valor do header Authorization

create_documents

Configuração para criar documentos.

documents

object[]

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

Array [

purposestring

Possible values: [ccb, signature, insurance]

engine

object

typestring

Template engine usado para gerar documentos.

Possible values: [google]

options

object

templatestring

Template utilizado no engine para gerar o documento.

]

unico

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

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

attachments_to_request

Tipo de anexos para verificação.

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.

]

disbursements

object

insurance

object

comboIdstringrequired

Identificador do combo de produto.

productIdstringrequired

Identificador do produto.

maxAmountdoublerequired

Valor máximo de cobertura do seguro.

typestring

Tipo de conta bancária.

Possible values: [base39, client_account]

account

object

anyOf

client_account

holderNamestringrequired

O nome da pessoa ou empresa que possui a conta bancária.

holderDocumentstringrequired

O documento da entidade que detém a conta. Pode ser CPF ou CNPJ.

bankCodestringrequired

Código COMPE da Instituição Financeira.

branchstringrequired

A agência da conta bancária.

numberstringrequired

O número da conta bancária. Deve ser uma conta corrente ou conta poupança.

digitstringrequired

property name*

SettingsDisbursements

Configurações de desembolso.

typestringrequired

Possible values: [qitech, bv, custom, mock, banco_paulista]

credentials

object

anyOf

QITech

urlstringrequired

URL do parceiro de bancarização.

Example: https://api-auth.sandbox.qitech.app

apiKeystringrequired

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

Example: abcdef12345

privateKeystringrequired

Chave privada do parceiro de bancarização.

Example: -----BEGIN RSA PRIVATE KEY-----\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\n-----END RSA PRIVATE KEY-----

publicKeystringrequired

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

Example: -----BEGIN PUBLIC KEY-----\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\n-----END PUBLIC KEY-----

ccbPrefixstringrequired

Prefixo da CCB.

passphrasestring

Frase secreta.

BV

clientIdstringrequired

Client ID.

clientSecretstringrequired

Client Secret.

fetchRebatesboolean

incluir TC nas propostas da BV.

Custom

urlstringrequired

URL do fundo.

Example: https://api.example.com

headersobject

Valor do header Authorization

Banco Paulista

promoterstring

Promotora

Example: 9999

storeChainstring

Rede de Lojas

Example: 9999

storestring

Loja

Example: 9999

productstring

Produto

Example: 9999

planstring

Plano

Example: 9999

userstring

Nome de usuário

Example: New User

supportedPaymentMethodsstring[]

Possible values: [invoice, boleto, paymentMethod.pix, paymentMethod.bankAccount]

disbursementDaystring

Possible values: [sameDay, nextWorkDay]

flags

object

Configurações de flags.

showCancelButtonBeforeDisbursementboolean

Mostrar o botão de cancelar antes do desembolso.

Example: true

automaticChargebackboolean

Reembolsar automaticamente valores pagos a mais pelos clientes

Example: true

notifications

object

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

email

object

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

providerstring

Provedor utilizado para envio de email.

Possible values: [default, test_only, smtp]

config

object

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

emailstring

E-mail utilizado para o envio.

hoststring

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

portnumber

Porta de conexão SMTP.

usernamestring

Nome de usuário do servidor SMTP.

passwordstring

Senha de usuário do servidor SMTP.

sms

object

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

providerstring

Provedor utilizado para envio de SMS.

Possible values: [test_only, infobip]

config

object

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

tokenstring

Token para conexão com a infobip.

basePathuri

Url base do provedor.

whatsapp

object

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

providerstring

Provedor utilizado para envio de mensagens via WhatsApp.

Possible values: [test_only, default, twilio]

config

object

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

accountstring

Conta da twilio.

tokenstring

Token para conexão com a twilio.

senderstring

Número de telefone base para envio da mensagem.

validations

object

Configurações de validadores.

pix

object

Configuração do provedor de PIX.

typestring

Tipo das credenciais do provedor de PIX.

Possible values: [qitech, custom, mock]

credentials

object

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

anyOf

QITech

Credênciais de QITech.

urlstringrequired

URL do parceiro de bancarização.

Example: https://api-auth.sandbox.qitech.app

apiKeystringrequired

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

Example: abcdef12345

privateKeystringrequired

Chave privada do parceiro de bancarização.

Example: -----BEGIN RSA PRIVATE KEY-----\nMIIBOgIBAAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9oQXSxo5c1iL+YC+dr4jm\nkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQJAMtWs6j3ytIbJ4CofHAy5\nD+aiZ+QqGMi8DqHl8spBNYYPlwNhpze2Ge9YnCx2Vkz46vLpP5KDAmQR8Vogea8E\nAQIhAOZCyFD4PgUNg02UiV9eBsFG61qlOHBZBMmWnAKKe7uBAiEAwNMBhsc6Wsl8\nyW7qYMtLljpBUdy0C5vEu0JKdvZYVnkCIAJ/gPrX5pxZbC5ASUk+lOYt5cnC9xzI\n6nNhbendJMCBAiBZasAfdw3ZgewLIRMxFbUUkikuRBF9/JsLV19esTgfyQIhANv2\n+R0S0bzykeZ5QZF+getN1TfdEviOxFnTu+my50DL\n-----END RSA PRIVATE KEY-----

publicKeystringrequired

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

Example: -----BEGIN PUBLIC KEY-----\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\n-----END PUBLIC KEY-----

ccbPrefixstringrequired

Prefixo da CCB.

passphrasestring

Frase secreta.

Custom

Credênciais customizadas do provedor PIX.

urlstringrequired

URL do serviço provedor de PIX.

Example: https://api.example.com

headersobject

Par de chave-valor usado como cabeçalho do serviço de validação.

Example: Authorization: Bearer value

Mock

Credênciais de mock(objeto que imita comportamento) do provedor PIX.

urlstring

URL do serviço provedor de PIX.

Example: https://api.base39.io/v1/mocks

headersobject

Par de chave-valor usado como cabeçalho do serviço de validação.

Example: Authorization: Bearer value

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.

expireInDaysnumber

Número de dias para expiração de um empréstimo, contando a partir da data de criação.

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

customerRecurring

object

Configuração de recorrência de fatura.

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

Possible values: [absolute]

Example: absolute

amountnumber

Quantidade de dias para fechamento da fatura.

Possible values: >= 1 and <= 28

Example: 10

create

object

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

autoCreateboolean

Define se a fatura deve ser criada automaticamente.

Example: true

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: false

companyRecurring

object

Configuração de recorrência de fatura.

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 usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.

Possible values: [static]

Example: static

amountnumber

Dia do mês para fechamento da fatura.

Possible values: >= 1 and <= 28

Example: 10

create

object

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

cutoffDaynumber

Define o dia limite para a edição de uma fatura, antes que ela seja fechada.

Example: 25

autoCreateboolean

Define se a fatura deve ser criada automaticamente.

Example: true

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: false

autoMoneyRelocationboolean

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

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.

property name*

object

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.

siteKeystring

Segredo para utilizar o recaptcha

employments

object

Configurações de vínculos empregatícios

expireInDaysinteger

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

Example: 30

domains

object

Configurações de domínios customizados

companystring

URL do Portal Empresa.

customerstring

URL do Portal Cliente.

backofficestring

URL do Backoffice.

queues

object[]

Configurações de fila

Array [

namestring

Nome da fila

Example: Fila de propostas

querystring

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

Example: status:open OR status:pending AND customer.id:`${customer.id}` AND created_at<`${date}` AND company.document:`${company.document}`

]

installments

object

Configurações de parcelas.

dueDate

object

Configuração de data de vencimento.

typestring

Tipo de data de vencimento. absolute representa o dia exato do mês, static representa o dia + amount.

Possible values: [absolute, static]

amountinteger

Quantidade de dias para vencimento.

Example: 10

graceDate

object

Configuração de data de carência.

typestring

Tipo de data de carência.

Possible values: [days, months]

amountinteger

Quantidade para carência.

Example: 10

skipInstallmentsinteger

Quantidade de parcelas que serão desconsideradas até a cobrança.

Example: 1

Example (from schema)

{
  "steps": {},
  "disbursements": {
    "insurance": {
      "comboId": "string",
      "productId": "string",
      "maxAmount": 0,
      "type": "base39"
    }
  },
  "flags": {
    "showCancelButtonBeforeDisbursement": true,
    "automaticChargeback": true
  },
  "notifications": {
    "email": {
      "provider": "default",
      "config": {
        "email": "string",
        "host": "string",
        "port": 0,
        "username": "string",
        "password": "string"
      }
    },
    "sms": {
      "provider": "test_only",
      "config": {
        "token": "string",
        "basePath": "string"
      }
    },
    "whatsapp": {
      "provider": "test_only",
      "config": {
        "account": "string",
        "token": "string",
        "sender": "string"
      }
    }
  },
  "validations": {
    "pix": {
      "type": "qitech"
    }
  },
  "loans": {
    "concurrency": [
      {
        "quantityAllowed": 0,
        "status": [
          "open"
        ]
      }
    ],
    "conditions": [
      {
        "title": "string",
        "content": "string"
      }
    ],
    "refin": {
      "minDays": 0
    },
    "expireInDays": 0
  },
  "invoices": {
    "payOff": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 1
      },
      "updateInvoiceItemOnInsert": true
    },
    "customerRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "absolute",
        "amount": 10
      },
      "create": {
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "companyRecurring": {
      "fine": {
        "amount": 0.02,
        "daysToStart": 1
      },
      "interest": {
        "amount": 0.01,
        "daysToStart": 1
      },
      "allowOverduePayment": true,
      "daysUntilDue": {
        "type": "static",
        "amount": 10
      },
      "create": {
        "cutoffDay": 25,
        "autoCreate": true
      },
      "updateInvoiceItemOnInsert": false
    },
    "autoMoneyRelocation": true
  },
  "locales": {
    "Brazil": {
      "states": {
        "MG": {
          "name": "Minas Gerais",
          "slug": "MG"
        }
      }
    }
  },
  "recaptcha": {
    "siteKey": "string"
  },
  "employments": {
    "expireInDays": 30
  },
  "domains": {
    "company": "string",
    "customer": "string",
    "backoffice": "string"
  },
  "queues": [
    {
      "name": "Fila de propostas",
      "query": "status:open OR status:pending AND customer.id:`${customer.id}` AND created_at<`${date}` AND company.document:`${company.document}`"
    }
  ],
  "installments": {
    "dueDate": {
      "type": "absolute",
      "amount": 10
    },
    "graceDate": {
      "type": "days",
      "amount": 10
    },
    "skipInstallments": 1
  }
}