Referências
- Empréstimos
- Empresas
- Políticas de crédito
- Esteira
- Clientes
- Funcionários
- Fundos
- Eventos
- Produtos
- Ofertas
- Assinaturas
- Grupos de empresas
- Operadores
- Permissões
- Itens da fatura
- Intenções de pagamento
- Métodos de pagamento
- Parcelas
- Webhooks externos
- Links de arquivos
- Arquivos
- Faturas
- Temas
- Chaves da API
- Configurações
- Entidade de dados
- Documentos
- Workflows
- Notificações
- Modelos
Configurações
Atualizar configurações
Atualiza as configurações.
POST
/
v1
/
settings
curl --request POST \
--url https://api.base39.io/v1/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"steps": {},
"disbursements": {},
"flags": {
"showCancelButtonBeforeDisbursement": true
},
"notifications": {
"email": {
"provider": "smtp",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"username": "<string>",
"password": "<string>"
}
},
"sms": {
"provider": "infobip",
"config": {
"token": "<string>",
"basePath": "<string>"
}
},
"whatsapp": {
"provider": "twilio",
"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>"
}
]
},
"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}`"
}
]
}'
{
"steps": {},
"disbursements": {},
"flags": {
"showCancelButtonBeforeDisbursement": true
},
"notifications": {
"email": {
"provider": "smtp",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"username": "<string>",
"password": "<string>"
}
},
"sms": {
"provider": "infobip",
"config": {
"token": "<string>",
"basePath": "<string>"
}
},
"whatsapp": {
"provider": "twilio",
"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>"
}
]
},
"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}`"
}
]
}
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
application/json
Criar configurações
Response
201 - application/json
Retorna o objeto Settings
se a atualização for bem-sucedida. Retorna um erro se os parâmetros de atualização forem inválidos.
Este objeto representa 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": {},
"flags": {
"showCancelButtonBeforeDisbursement": true
},
"notifications": {
"email": {
"provider": "smtp",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"username": "<string>",
"password": "<string>"
}
},
"sms": {
"provider": "infobip",
"config": {
"token": "<string>",
"basePath": "<string>"
}
},
"whatsapp": {
"provider": "twilio",
"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>"
}
]
},
"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}`"
}
]
}'
{
"steps": {},
"disbursements": {},
"flags": {
"showCancelButtonBeforeDisbursement": true
},
"notifications": {
"email": {
"provider": "smtp",
"config": {
"email": "<string>",
"host": "<string>",
"port": 123,
"username": "<string>",
"password": "<string>"
}
},
"sms": {
"provider": "infobip",
"config": {
"token": "<string>",
"basePath": "<string>"
}
},
"whatsapp": {
"provider": "twilio",
"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>"
}
]
},
"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}`"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.