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
- Settings
- ApiKeys
- ApiKey
- ApiKeyResponseCreate
- PaymentIntent
- PaymentIntents
- Company
- Companies
- CompanyGroup
- CompanyGroups
- CreditPolicy
- CreditPolicies
- CreditPolicyModelEmploymentLengthSalaryMultiplier
- Step
- Steps
- Loan
- Loans
- Offer
- Customer
- Customers
- Employment
- Employments
- Fund
- Funds
- Event
- Events
- ResendEvents
- PaymentMethod
- PaymentMethods
- Product
- Products
- ProductEligible
- ProductsEligibles
- Subscription
- Subscriptions
- Operator
- Operators
- Permission
- Permissions
- Installment
- Installments
- ExternalWebhooksQItech
- ExternalWebhooksKobana
- InvoiceItem
- InvoiceItems
- FileLink
- FileLinks
- File
- Invoice
- Invoices
- Themes
- DataEntity
- DataEntities
- Document
- Documents
- Workflows
- Workflow
- WorkflowExecution
- WorkflowExecutions
- WorkflowExecutionLog
- WorkflowExecutionLogs
- NotificationMessageAccepted
- WorkflowDefault
- WorkflowsDefault
- InvoicePayOff
- InvoiceCompanyRecurring
- InvoiceCustomerRecurring
- MethodData
- Address
- SettingsEmployments
- SettingsEmploymentsCompanies
- SettingsDomains
- SettingsPayments
- SettingsLoans
- SettingsLoansProducts
- SettingsProducts
- SettingsSteps
- SettingsDisbursements
- SettingsFlags
- SettingsFundFlags
- SettingsNotifications
- SettingsValidations
- SettingsRecaptcha
- SettingsQueues
- SettingsLocales
- SettingsInvoicesProducts
- SettingsInvoicesTenants
- SettingsInvoicesCompanies
- Deleted
- StepSignature
- CashoutTransfer
- CashoutBoleto
- CashoutInvoice
- CashoutLoan
- Transaction
- BankAccount
- PixKey
- PaymentMethodLink
- InstallmentTransaction
- Nationality
- State
- WorkflowsContent
- WorkflowsStatus
- WorkflowRunErrorNotAcceptable
- WorkflowTriggerScheduled
- WorkflowTriggerWebhookBase39
- BasicAuth
- SettingsCreate
- ApiKeyCreate
- CreditPolicyCreate
- InvoiceItemCreate
- PaymentIntentCreate
- PaymentIntentPay
- CompanyCreate
- OfferCreate
- LoanCreate
- CustomerCreate
- EmploymentCreate
- FundCreate
- ProductCreate
- SubscriptionCreate
- OperatorCreate
- PermissionCreate
- PaymentMethodsCreate
- InstallmentCreate
- CompanyGroupsCreate
- ExternalWebhooksQItechCreate
- ExternalWebhooksKobanaCreate
- ExternalWebhooksUnicoCreate
- Webhook
- Webhooks
- FileLinkCreate
- InvoiceCreate
- ThemesCreate
- DataEntityCreate
- DocumentCreate
- WorkflowCreate
- WorkflowRun
- SendSMS
- SendEmail
- SendWhatsapp
- Error
- WorkflowError406
- SessionEmailNotificationEvent
- SessionNotificationEvent
- NotificationEvent
SettingsProducts
Configurações de produtos
Define como a elegibildiade será calculada.
O tipo mock deve ser usado apenas para testes.
Use dynamic para integrar com uma API externa.
Para produtos que não exigem verificações, use o tipo static.
static, dynamic, mock "static"
Use o tipo online quando o processamento do produto e oferta serão feitos pela plataforma. Use offline para redirecionamento externo.
online, offline, mock "online"
Taxa de juros mensal
1.99
Opções de parcelas
[12, 24]
Dias até o desembolso. Essa informação é usada para calcular a oferta.
7
Quantidade de meses de carência até o vencimento da primeira parcela.
1
Tipo da operação de crédito.
"CCB"
Detalhes das taxas de um empréstimo.
Tipo da tarifa.
all_loans: utilizado para indicar tarifas ou taxas de manutenção em cada contratação.
first_loan: utilizado para representar taxas de cadastro ou Taxa de Contratação (TC).
except_first_loan: utilizado para representar taxas de manutenção em cada contratação, exceto a primeira.
all_loans, first_loan, except_first_loan "first_loan"
Tipo do valor a ser cobrado.
percentage "percentage"
Porcentagem da tarifa a ser cobrado sobre o valor do empréstimo.
0.2
Descrição para a tarifa.
"Tarifa de cadastro"
Valor mínimo para aplicação da tarifa.
200
Valor máximo para aplicação da tarifa.
2000
0
1.73
required, optional, uninsured "required"
"123456"
"Cia de Seguros"
Documentos criados após a criação do empréstimo, exemplos: ccb, seguro, etc… ATENÇÃO: Este campo entrará em desuso em breve, utilize os steps para definir quais documentos deverão ser criados.
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 Template engine usado para gerar documentos.
google documentos solicitados durante o fluxo de contratação, exemplos: RG, CPF, Holerite, Comprovante de endereço…
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 Nome do documento.
"crédito consignado"
Identificador do responsável por solicitar/criar o documento.
customer, operator "customer"
Número de dias até a expiração.
x >= 130
Nome do método de desembolso configurado na API de Configurações
"custom"
{
"eligibility": {
"type": "static",
"options": {
"url": "<string>",
"headers": {},
"metadata": {}
}
},
"offer": {
"type": "online",
"options": {
"monthlyFee": 1.99,
"numberOfInstallments": [
12,
24
],
"daysUntilDisbursement": 7,
"monthsUntilFirstDueDate": 1,
"creditOperationType": "CCB",
"rebates": [
{
"feeType": "first_loan",
"amountType": "percentage",
"amount": 0.2,
"description": "Tarifa de cadastro",
"minAmount": 200,
"maxAmount": 2000
}
],
"insurance": {
"amount": 0,
"fee": 1.73,
"type": "required",
"number": "123456",
"insurer": "Cia de Seguros"
}
}
},
"documents": {
"toCreate": [
{
"purpose": "account_requirement",
"method": "google",
"methodData": {
"template": "<string>"
}
}
],
"toRequest": [
{
"purpose": "account_requirement",
"name": "crédito consignado",
"owner": "customer",
"expireInDays": 30
}
]
},
"disbursement": "custom"
}