These docs are for v1.2. Click to read the latest docs for v1.4.

Crédito Solar

Se você é uma empresa de projetos de energia solar, a API de Crédito Solar permite fazer análises de crédito de seus clientes diretamente na sua plataforma. Com dados como contas de luz, valor da instalação e CEP, você consegue fazer a cotação de seu cliente. Caso ele esteja apto, você tem informações como taxas, carência e limites.

Casos de Uso

  • Solicitar análises de crédito para projetos de energia solar.
  • Consultar homologação de distribuidores de insumos 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 Crédito Solar deve ser gerado usando o Client Credentials.

É necessário escolher um dos seguintes escopos:

EscopoDescrição
empresas.btgpactual.com/solar-creditPermite enviar pré-analises e consultas, incluindo de integrador/distribuidor.
empresas.btgpactual.com/solar-credit.readonlyPermite enviar apenas pré-analises e consultas de integrador/distribuidor.

Recursos Disponíveis

Os recursos da API de Crédito Solar estão disponíveis no API Reference.

📘

API Reference

Crédito Solar API

Eventos

A API de Crédito Solar 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": "WaitingAnalysis",
    "originId": "93806596-15dd-4b80-a222-73deeb70d519",
    "occurrenceDate": "2023-12-11T16:26:29.072171",
    "productType": "Solar"
}

Status possíveis:

DescriçãoStatus AntigoStatus Novo
Aguardando análise interna dos dados cadastraisEM_CADASTROAccountCreationAnalysis
Dados cadastrais foram pendenciados, necessário ajuste das informaçõesEM_CADASTROAccountCreationDataAdjustment
Abertura de conta reprovadaDOCUMENTOS_REJEITADOSAccountCreationDisapproved
Proposta expirou na etapa de abertura de contaVENCIDOAccountCreationExpired
Iniciando abertura de conta do clienteEM_CADASTROAccountCreationStartingOnboarding
Pendente envio de formulário de dados cadastraisEM_CADASTROAccountCreationPendingSubmit
Pendente assinatura do termo de abertura de contaEM_CADASTROAccountCreationWaitingSignatures
Valor do crédito desembolsadoCONCLUIDOContractingOperationDisbursed
Aguardando contratação do crédito pelo clienteAGUARDANDO_DESEMBOLSOContractingWaitingOperation
Operação contratada, aguardando desembolso do créditoAGUARDANDO_DESEMBOLSOContractingWaitingDisbursement
Aguardando assinaturas para liberação do créditoAGUARDANDO_DESEMBOLSOContractingWaitingSignatures
Proposta foi reprovada na etapa de contrataçãoDOCUMENTOS_REJEITADOSContractingDisapproved
Proposta expirou na etapa de contrataçãoVENCIDOContractingExpired
Aguardando análise interna dos documentos de comprovaçãoANALISE_DOCUMENTACAODocumentsAnalysis
Documentos foram pendenciados, necessário ajuste das informaçõesAJUSTE_DOCUMENTACAODocumentsDataAdjustment
Proposta expirou na etapa de envio de documentosVENCIDODocumentsExpired
Pendente envio dos documentos de comprovação das informações da propostaPENDENTE_DOCUMENTACAODocumentsPendingSubmit
Documentos foram rejeitadosDOCUMENTOS_REJEITADOSDocumentsDisapproved
Proposta expirou na etapa de análise final de créditoVENCIDOFinalProposalExpired
Proposta de crédito disponível para aceite do clienteAGUARDANDO_ACEITEFinalProposalPendingAccept
Aguardando análise interna das notas fiscaisANALISE_DOCUMENTACAOInvoicesAnalysis
Notas fiscais foram pendenciadas, necessário ajuste das informaçõesAJUSTE_DOCUMENTACAOInvoicesDataAdjustment
Proposta expirou na etapa de envio de notas fiscaisVENCIDOInvoicesExpired
Pendente liberação do limite do integrador para proposta fluirN/AInvoicesPendingLimitAvailability
Pendente envio das notas fiscais para análiseENVIO_NFEInvoicesPendingSubmit
Notas fiscais foram rejeitadasDOCUMENTOS_REJEITADOSInvoicesDisapproved
Aguardando análise de crédito internaEM_ANALISELeadViabilityAnalysis
Proposta expirou na etapa de análise de viabilidadeVENCIDOLeadViabilityExpired
Pendente envio das informações básicas para a solicitação do créditoFORMULARIO_PREENCHIMENTOLeadViabilityPendingSubmit
Pendente ajuste das informações básicas para a solicitação do créditoFORMULARIO_PREENCHIMENTOLeadViabilityDataAdjustment
Proposta reprovada por créditoREPROVADO_MOTORLeadViabilityDisapproved