Empréstimos
- Empréstimos
- Políticas de crédito
- Esteira
- Produtos
- Ofertas
- Parcelas
Empresas
- Empresas
- Grupos de empresas
- Operadores
- Permissões
- Métodos de pagamento
Clientes
- Clientes
- Funcionários
Fundos
- Fundos
Eventos
- Eventos
- Assinaturas
- Webhooks externos
- Webhooks
- Notificações
Cobrança
- Itens da fatura
- Intenções de pagamento
- Faturas
Arquivos
- Links de arquivos
- Arquivos
Configurações
- Temas
- Chaves da API
- Configurações
Entidades
- Entidade de dados
- Documentos
Automações
- Workflows
Modelos
- Modelos
Atualizar configurações
Atualiza as configurações.
curl --request POST \
--url https://api.base39.io/v1/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"steps": {},
"disbursements": {
"insurance": {
"comboId": "<string>",
"productId": "<string>",
"maxAmount": 123,
"type": "base39",
"account": {
"holderName": "<string>",
"holderDocument": "<string>",
"bankCode": "<string>",
"branch": "<string>",
"number": "<string>",
"digit": "<string>"
}
}
},
"flags": {
"showCancelButtonBeforeDisbursement": true,
"automaticChargeback": true
},
"notifications": {
"email": {
"provider": "default",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"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",
"credentials": {
"url": "https://api-auth.sandbox.qitech.app",
"apiKey": "abcdef12345",
"privateKey": "-----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-----",
"publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
"ccbPrefix": "<string>",
"passphrase": "<string>"
}
}
},
"loans": {
"concurrency": [
{
"quantityAllowed": 123,
"status": [
"open"
]
}
],
"conditions": [
{
"title": "<string>",
"content": "<string>"
}
],
"refin": {
"minDays": 123
},
"expireInDays": 123
},
"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
}
}'{
"steps": {},
"disbursements": {
"insurance": {
"comboId": "<string>",
"productId": "<string>",
"maxAmount": 123,
"type": "base39",
"account": {
"holderName": "<string>",
"holderDocument": "<string>",
"bankCode": "<string>",
"branch": "<string>",
"number": "<string>",
"digit": "<string>"
}
}
},
"flags": {
"showCancelButtonBeforeDisbursement": true,
"automaticChargeback": true
},
"notifications": {
"email": {
"provider": "default",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"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",
"credentials": {
"url": "https://api-auth.sandbox.qitech.app",
"apiKey": "abcdef12345",
"privateKey": "-----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-----",
"publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
"ccbPrefix": "<string>",
"passphrase": "<string>"
}
}
},
"loans": {
"concurrency": [
{
"quantityAllowed": 123,
"status": [
"open"
]
}
],
"conditions": [
{
"title": "<string>",
"content": "<string>"
}
],
"refin": {
"minDays": 123
},
"expireInDays": 123
},
"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
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Chave única de idempotência para evitar duplicação de requisições.
Body
Criar configurações
Configurações de fluxos em modo passo a passo do empréstimos.
Configurações do modo passo a passo
Título identificador do passo.
Tipo identificador do passo.
signature, disburse, document_verification, pass, valid_employment, custom_request, create_documents, attachments_to_request, unico 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.
Array de dependência (slugs) entre os passos necessarios para que esse seja executado.
Slug do passo (step) dependente.
Definição de hooks da esteira.
Identificador do combo de produto.
Identificador do produto.
Valor máximo de cobertura do seguro.
Tipo de conta bancária.
base39, client_account O nome da pessoa ou empresa que possui a conta bancária.
O documento da entidade que detém a conta. Pode ser CPF ou CNPJ.
Código COMPE da Instituição Financeira.
A agência da conta bancária.
O número da conta bancária. Deve ser uma conta corrente ou conta poupança.
Configurações de desembolso.
qitech, bv, custom, mock, banco_paulista URL do parceiro de bancarização.
"https://api-auth.sandbox.qitech.app"
Chave de acesso à api do parceiro de bancarização.
"abcdef12345"
Chave privada do parceiro de bancarização.
"-----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-----"
Chave pública do parceiro de bancarização.
"-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----"
Prefixo da CCB.
Frase secreta.
invoice, boleto, paymentMethod.pix, paymentMethod.bankAccount sameDay, nextWorkDay Configurações de serviços provedores de notificações.
Configurações do provedor de notificações via e-mail.
Provedor utilizado para envio de email.
default, test_only, smtp Objeto para definir a configuração para utilização do provedor de email.
E-mail utilizado para o envio.
Nome do host ou endereço IP ao qual se conectar.
Porta de conexão SMTP.
Nome de usuário do servidor SMTP.
Senha de usuário do servidor SMTP.
Configurações do provedor de notificações via SMS.
Provedor utilizado para envio de SMS.
test_only, infobip Configurações do provedor de notificações via WhatsApp.
Provedor utilizado para envio de mensagens via WhatsApp.
test_only, default, twilio Objeto para definir a configuração para utilização do provedor de mensagens via WhatsApp.
Configurações de validadores.
Configuração do provedor de PIX.
Tipo das credenciais do provedor de PIX.
qitech, custom, mock Credênciais de QITech.
URL do parceiro de bancarização.
"https://api-auth.sandbox.qitech.app"
Chave de acesso à api do parceiro de bancarização.
"abcdef12345"
Chave privada do parceiro de bancarização.
"-----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-----"
Chave pública do parceiro de bancarização.
"-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----"
Prefixo da CCB.
Frase secreta.
Configurações de empréstimos
Configurações referentes às limitações na criação de loans simultâneos.
Configurações referentes à refinanciamento de empréstimos.
Número mínimo de dias necessário para que uma proposta possa ser refinanciada, contado a partir da criação da proposta.
Número de dias para expiração de um empréstimo, contando a partir da data de criação.
Configurações de faturas
Configurações de quitação.
Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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).
0.02
Quantidade de dias após o vencimento que a multa começará a incidir.
1
Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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.
0.01
Quantidade de dias após o vencimento que juro começará a incidir.
1
Permite pagamento da fatura após o vencimento.
true
Definição de regras para o fechamento da fatura.
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.
absolute "absolute"
Dia exato ou a quantidade de dias.
1 <= x <= 281
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.
true
Configuração de recorrência de fatura.
Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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).
0.02
Quantidade de dias após o vencimento que a multa começará a incidir.
1
Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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.
0.01
Quantidade de dias após o vencimento que juro começará a incidir.
1
Permite pagamento da fatura após o vencimento.
true
Definição de regras para o fechamento da fatura.
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.
absolute "absolute"
Quantidade de dias para fechamento da fatura.
1 <= x <= 2810
Definição de regras para geração de fatura.
Define se a fatura deve ser criada automaticamente.
true
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.
false
Configuração de recorrência de fatura.
Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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).
0.02
Quantidade de dias após o vencimento que a multa começará a incidir.
1
Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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.
0.01
Quantidade de dias após o vencimento que juro começará a incidir.
1
Permite pagamento da fatura após o vencimento.
true
Definição de regras para o fechamento da fatura.
Tipo de dias usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.
static "static"
Dia do mês para fechamento da fatura.
1 <= x <= 2810
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.
false
Se verdadeiro, o sistema irá fazer o remanejo automático de dinheiro entre as parcelas que possuem valor pago excedente.
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.
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.
Segredo para utilizar o recaptcha
Configurações de vínculos empregatícios
Quantidade de dias para expirar o vínculo empregatício.
30
Configurações de fila
Nome da fila
"Fila de propostas"
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
"status:open OR status:pending AND customer.id:${customer.id} AND created_at<${date} AND company.document:${company.document}"
Configurações de parcelas.
Quantidade de parcelas que serão desconsideradas até a cobrança.
1
Response
Este objeto representa as configurações.
Configurações de fluxos em modo passo a passo do empréstimos.
Configurações do modo passo a passo
Título identificador do passo.
Tipo identificador do passo.
signature, disburse, document_verification, pass, valid_employment, custom_request, create_documents, attachments_to_request, unico 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.
Array de dependência (slugs) entre os passos necessarios para que esse seja executado.
Slug do passo (step) dependente.
Identificador único do passo.
Definição de hooks da esteira.
Identificador do combo de produto.
Identificador do produto.
Valor máximo de cobertura do seguro.
Tipo de conta bancária.
base39, client_account O nome da pessoa ou empresa que possui a conta bancária.
O documento da entidade que detém a conta. Pode ser CPF ou CNPJ.
Código COMPE da Instituição Financeira.
A agência da conta bancária.
O número da conta bancária. Deve ser uma conta corrente ou conta poupança.
Configurações de desembolso.
qitech, bv, custom, mock, banco_paulista URL do parceiro de bancarização.
"https://api-auth.sandbox.qitech.app"
Chave de acesso à api do parceiro de bancarização.
"abcdef12345"
Chave privada do parceiro de bancarização.
"-----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-----"
Chave pública do parceiro de bancarização.
"-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----"
Prefixo da CCB.
Frase secreta.
invoice, boleto, paymentMethod.pix, paymentMethod.bankAccount sameDay, nextWorkDay Configurações de serviços provedores de notificações.
Configurações do provedor de notificações via e-mail.
Provedor utilizado para envio de email.
default, test_only, smtp Objeto para definir a configuração para utilização do provedor de email.
E-mail utilizado para o envio.
Nome do host ou endereço IP ao qual se conectar.
Porta de conexão SMTP.
Nome de usuário do servidor SMTP.
Senha de usuário do servidor SMTP.
Configurações do provedor de notificações via SMS.
Provedor utilizado para envio de SMS.
test_only, infobip Configurações do provedor de notificações via WhatsApp.
Provedor utilizado para envio de mensagens via WhatsApp.
test_only, default, twilio Objeto para definir a configuração para utilização do provedor de mensagens via WhatsApp.
Configurações de validadores.
Configuração do provedor de PIX.
Tipo das credenciais do provedor de PIX.
qitech, custom, mock Credênciais de QITech.
URL do parceiro de bancarização.
"https://api-auth.sandbox.qitech.app"
Chave de acesso à api do parceiro de bancarização.
"abcdef12345"
Chave privada do parceiro de bancarização.
"-----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-----"
Chave pública do parceiro de bancarização.
"-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----"
Prefixo da CCB.
Frase secreta.
Configurações de empréstimos
Configurações referentes às limitações na criação de loans simultâneos.
Configurações referentes à refinanciamento de empréstimos.
Número mínimo de dias necessário para que uma proposta possa ser refinanciada, contado a partir da criação da proposta.
Número de dias para expiração de um empréstimo, contando a partir da data de criação.
Configurações de faturas
Configurações de quitação.
Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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).
0.02
Quantidade de dias após o vencimento que a multa começará a incidir.
1
Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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.
0.01
Quantidade de dias após o vencimento que juro começará a incidir.
1
Permite pagamento da fatura após o vencimento.
true
Definição de regras para o fechamento da fatura.
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.
absolute "absolute"
Dia exato ou a quantidade de dias.
1 <= x <= 281
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.
true
Configuração de recorrência de fatura.
Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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).
0.02
Quantidade de dias após o vencimento que a multa começará a incidir.
1
Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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.
0.01
Quantidade de dias após o vencimento que juro começará a incidir.
1
Permite pagamento da fatura após o vencimento.
true
Definição de regras para o fechamento da fatura.
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.
absolute "absolute"
Quantidade de dias para fechamento da fatura.
1 <= x <= 2810
Definição de regras para geração de fatura.
Define se a fatura deve ser criada automaticamente.
true
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.
false
Configuração de recorrência de fatura.
Definição de incidência de multas. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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).
0.02
Quantidade de dias após o vencimento que a multa começará a incidir.
1
Definição de incidência de juros. Campo reservado para instruções específicas do boleto. Não se aplica a cálculos.
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.
0.01
Quantidade de dias após o vencimento que juro começará a incidir.
1
Permite pagamento da fatura após o vencimento.
true
Definição de regras para o fechamento da fatura.
Tipo de dias usado no fechamento da fatura. Representa o dia do mês (1 até 28) para fechamento da fatura.
static "static"
Dia do mês para fechamento da fatura.
1 <= x <= 2810
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.
false
Se verdadeiro, o sistema irá fazer o remanejo automático de dinheiro entre as parcelas que possuem valor pago excedente.
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.
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.
Segredo para utilizar o recaptcha
Configurações de vínculos empregatícios
Quantidade de dias para expirar o vínculo empregatício.
30
Configurações de fila
Nome da fila
"Fila de propostas"
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
"status:open OR status:pending AND customer.id:${customer.id} AND created_at<${date} AND company.document:${company.document}"
Configurações de parcelas.
Quantidade de parcelas que serão desconsideradas até a cobrança.
1
curl --request POST \
--url https://api.base39.io/v1/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"steps": {},
"disbursements": {
"insurance": {
"comboId": "<string>",
"productId": "<string>",
"maxAmount": 123,
"type": "base39",
"account": {
"holderName": "<string>",
"holderDocument": "<string>",
"bankCode": "<string>",
"branch": "<string>",
"number": "<string>",
"digit": "<string>"
}
}
},
"flags": {
"showCancelButtonBeforeDisbursement": true,
"automaticChargeback": true
},
"notifications": {
"email": {
"provider": "default",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"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",
"credentials": {
"url": "https://api-auth.sandbox.qitech.app",
"apiKey": "abcdef12345",
"privateKey": "-----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-----",
"publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
"ccbPrefix": "<string>",
"passphrase": "<string>"
}
}
},
"loans": {
"concurrency": [
{
"quantityAllowed": 123,
"status": [
"open"
]
}
],
"conditions": [
{
"title": "<string>",
"content": "<string>"
}
],
"refin": {
"minDays": 123
},
"expireInDays": 123
},
"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
}
}'{
"steps": {},
"disbursements": {
"insurance": {
"comboId": "<string>",
"productId": "<string>",
"maxAmount": 123,
"type": "base39",
"account": {
"holderName": "<string>",
"holderDocument": "<string>",
"bankCode": "<string>",
"branch": "<string>",
"number": "<string>",
"digit": "<string>"
}
}
},
"flags": {
"showCancelButtonBeforeDisbursement": true,
"automaticChargeback": true
},
"notifications": {
"email": {
"provider": "default",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"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",
"credentials": {
"url": "https://api-auth.sandbox.qitech.app",
"apiKey": "abcdef12345",
"privateKey": "-----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-----",
"publicKey": "-----BEGIN PUBLIC KEY-----\\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAK1v4KdR2rDDg4LU+9uI7ImVtQ4zcUC9\\noQXSxo5c1iL+YC+dr4jmkSU1rAs8czUpBHZj/0nagBmBHgjP5W/Q9fkCAwEAAQ==\\n-----END PUBLIC KEY-----",
"ccbPrefix": "<string>",
"passphrase": "<string>"
}
}
},
"loans": {
"concurrency": [
{
"quantityAllowed": 123,
"status": [
"open"
]
}
],
"conditions": [
{
"title": "<string>",
"content": "<string>"
}
],
"refin": {
"minDays": 123
},
"expireInDays": 123
},
"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
}
}