Solar workflow
Se você é uma empresa de projetos de energia solar, a API de Solar Worflow permite construir uma integração análoga à jornada existente no BTG Pactual Empresas diretamente na sua plataforma. A API entrega todo o worflow necessário para uma integração solar, cobrindo desde a geração de análise de crédito até o envio do comprovante de uma instalação bem sucedida do equipamento contratado pelo seu cliente.
Casos de Uso
- Construção da jornada completa ou parcial do workflow de energia solar
Segurança
BTG Id
O Authorization Server do BTG Empresas se chama BTG Id. Usando o BTG Id, um aplicativo parceiro consegue consentimento e autorização para executar operações nas APIs do BTG em nome do cliente. Para saber mais, acesse a documentação do BTG Id
Escopos necessários
O token para consumir a API de Solar Workflow deve ser gerado usando o Client Credentials.
É necessário utilizar o escopo abaixo:
| Escopo | Descrição |
|---|---|
brn:btg:empresas:solar:workflow | Permite utilizar as APIs referente ao Workflow de energia solar |
Workflow
Recursos Disponíveis
Os recursos da API de Solar Workflow estão disponíveis no API Reference.
API Reference
Envio dos dados iniciais para dar inicio à jornada
Eventos
A API de Solar Workflow disponibiliza os seguintes eventos de webhook:
credito-solar.analyzed
Crédito analisado.
{
"taxId": "00000000000",
"effectiveness": "PreApproved",
"productLimit": 50000.0,
"limitDateExpire": "2024-03-13T00:00:00",
"product": "Solar",
"approvedPaymentTerms": [
{
"gracePeriod": 3,
"installmentsMin": 96,
"installmentsMax": 96,
"monthlyRate": 0.0162,
"yearRate": 0.21,
"monthCet": 0.02,
"yearCet": 0.22,
"amount": 130000.0,
"instalmentAmount": 1350.0
}
],
"originId": "93806596-15dd-4b80-a222-73deeb70d519",
"description": "O valor das parcelas mensais é estimado e poderá variar conforme data de assinatura do contrato de empréstimo, bem como da data escolhida para pagamento das prestações.\nA liberação dos recursos estará condicionada à prévia concordância dos termos do financiamento entre as partes e negociação e preparação de toda a documentação necessária em condições satisfatórias ao BTG Pactual, bem como da análise cadastral completa do Cliente e da perfeita formalização das garantias.\nA presente proposta é válida pelo prazo de 5 (cinco) dias úteis contados da presente data."
}
credito-solar.changed-status
Mudança no status da análise.
{
"taxId": "00000000000",
"status": "DocumentsAnalysis",
"originId": "93806596-15dd-4b80-a222-73deeb70d519",
"occurrenceDate": "2023-12-11T16:26:29.072171",
"productType": "Solar"
}
Status possíveis:
| Descrição | Status Antigo | Status Novo |
|---|---|---|
| Aguardando análise interna dos dados cadastrais | EM_CADASTRO | AccountCreationAnalysis |
| Dados cadastrais foram pendenciados, necessário ajuste das informações | EM_CADASTRO | AccountCreationDataAdjustment |
| Abertura de conta reprovada | DOCUMENTOS_REJEITADOS | AccountCreationDisapproved |
| Proposta expirou na etapa de abertura de conta | VENCIDO | AccountCreationExpired |
| Iniciando abertura de conta do cliente | EM_CADASTRO | AccountCreationStartingOnboarding |
| Pendente envio de formulário de dados cadastrais | EM_CADASTRO | AccountCreationPendingSubmit |
| Pendente assinatura do termo de abertura de conta | EM_CADASTRO | AccountCreationWaitingSignatures |
| Valor do crédito desembolsado | CONCLUIDO | ContractingOperationDisbursed |
| Aguardando contratação do crédito pelo cliente | AGUARDANDO_DESEMBOLSO | ContractingWaitingOperation |
| Operação contratada, aguardando desembolso do crédito | AGUARDANDO_DESEMBOLSO | ContractingWaitingDisbursement |
| Aguardando assinaturas para liberação do crédito | AGUARDANDO_DESEMBOLSO | ContractingWaitingSignatures |
| Proposta foi reprovada na etapa de contratação | DOCUMENTOS_REJEITADOS | ContractingDisapproved |
| Proposta expirou na etapa de contratação | VENCIDO | ContractingExpired |
| Aguardando análise interna dos documentos de comprovação | ANALISE_DOCUMENTACAO | DocumentsAnalysis |
| Documentos foram pendenciados, necessário ajuste das informações | AJUSTE_DOCUMENTACAO | DocumentsDataAdjustment |
| Proposta expirou na etapa de envio de documentos | VENCIDO | DocumentsExpired |
| Pendente envio dos documentos de comprovação das informações da proposta | PENDENTE_DOCUMENTACAO | DocumentsPendingSubmit |
| Documentos foram rejeitados | DOCUMENTOS_REJEITADOS | DocumentsDisapproved |
| Proposta expirou na etapa de análise final de crédito | VENCIDO | FinalProposalExpired |
| Proposta de crédito disponível para aceite do cliente | AGUARDANDO_ACEITE | FinalProposalPendingAccept |
| Aguardando análise interna das notas fiscais | ANALISE_DOCUMENTACAO | InvoicesAnalysis |
| Notas fiscais foram pendenciadas, necessário ajuste das informações | AJUSTE_DOCUMENTACAO | InvoicesDataAdjustment |
| Proposta expirou na etapa de envio de notas fiscais | VENCIDO | InvoicesExpired |
| Pendente liberação do limite do integrador para proposta fluir | N/A | InvoicesPendingLimitAvailability |
| Pendente envio das notas fiscais para análise | ENVIO_NFE | InvoicesPendingSubmit |
| Notas fiscais foram rejeitadas | DOCUMENTOS_REJEITADOS | InvoicesDisapproved |
| Aguardando análise de crédito interna | EM_ANALISE | LeadViabilityAnalysis |
| Proposta expirou na etapa de análise de viabilidade | VENCIDO | LeadViabilityExpired |
| Pendente envio das informações básicas para a solicitação do crédito | FORMULARIO_PREENCHIMENTO | LeadViabilityPendingSubmit |
| Pendente ajuste das informações básicas para a solicitação do crédito | FORMULARIO_PREENCHIMENTO | LeadViabilityDataAdjustment |
| Proposta reprovada por crédito | REPROVADO_MOTOR | LeadViabilityDisapproved |
Updated 27 days ago