Capital de Giro
Este serviço permite que o cliente PJ do BTG Pactual Empresas iniciar o fluxo de workflow de capital de giro
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 contas com open finance deve ser gerado usando o Client credentials.
É necessário informar o seguinte escopo na realização do fluxo:
| Escopo | Descrição |
|---|---|
| brn:btg:empresas:kgiro:workflow | Acesso ao workflow de capital de giro |
Recursos Disponíveis
Os recursos da API de contas com open finance estão disponíveis no API Reference.
API Reference
Eventos
A API de worflow de capital de giro tem seus webhooks divididos em duas famílias de eventos: Eventos de motor de crédito e evento de mudança de status.
Eventos de motor de crédito
| Evento | Descrição |
|---|---|
| credit-kgiro.kgiro-analyzed | Resposta da análise de capital de giro |
| credit-kgiro.overdraft-analyzed | Resposta da análise de limite da conta |
| credit-kgiro.card-analyzed | Resposta da análise de cartão de crédito |
| credit-kgiro.collection-receivable-analyzed | Resposta da análise de desconto de duplicatas |
| credit-kgiro.card-receivable-analyzed | Resposta da análise de antecipação de recebíveis de cartão |
Payload
{
"externalId": "GUID",
"status": "Approved", // Approved, NotApproved
"approvedAmount": 100000.00,
"expirationDate": "2025-12-31",
"customerIdentification": "CNPJ",
"indexCode": "PRE", // CDI, PRE, NIPCA
"fundingType": "BTG", //BTG, BNDES
"product": "KGIRO",
"quotes": [
{
"rate": 0.5,
"minTerm": 12,
"maxTerm": 60,
"minGracePeriod": 3,
"maxGracePeriod": 12,
"rateFrequency": "MENSAL"
}
],
"guarantors": [
{
"type": "SIMPLES",
"guarantorIdentification": "CPF"
},
{
"type": "COMPLETO",
"guarantorIdentification": "CPF"
}
]
}Eventos de mudança de status
| Evento | Descrição |
|---|---|
| credit-kgiro.changed-status | Mudança de status |
Payload
{
"taxId": "CNPJ",
"status": "CreditAnalysisDisapproved",
"originId": "4d4df455-bfc8-4235-b7b0-c3146c24647b",
"occurrenceDate": "2025-01-23T17:26:00.699801",
"productType": "Kgiro"
}O campo status pode assumir os seguintes valores.
| Status possíveis | Descrição |
|---|---|
| CreditPendingSubmit | Pendente envio da solicitação de crédito |
| CreditPreAnalysized | Solicitação aprovada na pré-análise de crédito |
| CreditAnalysis | Solicitação sob análise de crédito |
| CreditPendingScr | Pendente confirmação do Optin SCR enviado por e-mail para o cliente |
| CreditPendingECnpj | Pendente envio do certificado A1 (e-CNPJ) solicitado por e-mail para o cliente |
| CreditExpired | Solicitação expirou na etapa de análise de crédito |
| CreditDisapproved | Solicitação foi reprovada na etapa de análise de crédito |
| CreditDataAdjustment | Solicitação possui pendências a serem resolvidas na etapa de crédito |
| CreditApproved | Solicitação foi aprovada na análise de crédito |
| AccountCreationWaitingForOnboarding | Aguardando início do processo onboarding do cliente na plataforma |
| AccountCreationPendingSubmit | Pendente envio das informações do cliente para abertura de conta na plataforma |
| AccountCreationAnalysis | Informações do cliente para abertura de conta sob análise |
| AccountCreationWaitingSignatures | Aguardando assinaturas do cliente para realização da abertura de conta |
| AccountCreationDisapproved | Abertura de conta reprovada |
| AccountCreationDataAdjustment | Pendente ajustes nas informações de abertura de conta do cliente |
| ContractingWaitingOperation | Aguardando contratação de crédito pelo cliente |
| ContractingGuarantorsOnboarding | Aguardando onboarding dos avalistas da contratação do crédito |
| ContractingWaitingSignatures | Pendente assinaturas do cliente para contratação do crédito |
| ContractingWaitingDisbursement | Aguardando desembolso do crédito na conta do cliente |
| ContractingOperationDisbursed | Desembolso do crédito realizado |
| ContractingContracted | Crédito contratado pela plataforma |
Updated 13 days ago