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.

EscopoDescrição
empresas.btgpactual.com/loansPermite 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

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

fidc-partnerfile.bookkeping

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

fidc-parterfile.offboarding

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