Fluxo de consignado privado

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 Fluxo de consignado privado deve ser gerado usando o Client Credentials.

Escopo	Descrição
`empresas.btgpactual.com/loans`	Permite operar a API de Fluxo de consignado privado.

Eventos de webhook

Os payloads disponíveis abaixo representam o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.

fidc-partnerfile.customerBaseEvaluation

Exemplo de arquivo de input: Input de customerBaseEvaluation

Status	Descrição
Validating	Validando arquivo enviado.
WaitingCreditEngine	Aguardando retorno do motor de crédito.
Processed	Jornada do arquivo concluída.
Invalid	Arquivo fora do formato esperado.

{
  "correlationId": "599999d6-9852-4c28-b07d-3d138e96456c",
  "status": "Processed",
  "s3Url": "https://btgpactual.s3.amazonaws.com/hD73Hgts3TsasdfghOjs24Js0"
}

fidc-partnerfile.bookkeping

Examplo de aquivo de input: Input de bookkeping

Status	Descrição
Validating	Validando o arquivo enviado.
WaitingCros	Aguardando retorno do Cros.
Processed	Jornada do arquivo concluída.
Invalid	Arquivo fora do formato esperado.

{
  "correlationId": "599999d6-9852-4c28-b07d-3d138e96456c",
  "status": "WaitingCros",
}

fidc-parterfile.offboarding

Exemplo de arquivo de input: Input de offboarding

Status	Descrição
Validating	Validando o arquivo enviado.
WaitingCros	Aguardando retorno do Cros.
Processed	Jornada do arquivo concluída.
Invalid	Arquivo fora do formato esperado.

{
  "correlationId": "599999d6-9852-4c28-b07d-3d138e96456c",
  "status": "Processed",
}