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 Risco Sacado deve ser gerado usando o Client Credentials.
É necessário escolher um dos seguintes escopos:
| Escopo | Descrição |
|---|---|
empresas.btgpactual.com/scf/borderos | Permite criar e consultar conjuntos de recebíveis (borderôs) |
empresas.btgpactual.com/scf/borderos.readonly | Permite consultar conjuntos de recebíveis (borderôs) |
empresas.btgpactual.com/scf/companies | .Permite cadastrar e consultar fornecedores |
empresas.btgpactual.com/scf/companies.readonly | Permite consultar fornecedores |
empresas.btgpactual.com/scf/operations | Permite criar e consultar operação de antecipação de recebíveis |
empresas.btgpactual.com/scf/operations.readonly | Permite consultar operação de antecipação de recebíveis |
empresas.btgpactual.com/scf/settlements | Permite cadastrar e consultar pagamento de recebíveis antecipados |
empresas.btgpactual.com/scf/settlements.readonly | Permite consultar pagamento de recebíveis antecipados |
empresas.btgpactual.com/assignment-coobligation | Permite gerenciar limites e conjuntos de recebíveis (borderôs) para cessão com coobrigação |
empresas.btgpactual.com/assignment-coobligation.readonly | Permite consultar limites e conjuntos de recebíveis (borderôs) para cessão com coobrigação |
Eventos de Webhook
A API de Risco Sacado e cessão com coobrigação disponibiliza os seguintes eventos de webhook:
| Evento | Descrição |
|---|---|
receivables.changed-status | Informações sobre o status de um recebível |
assignment-coobligation.converted-operation | Informações sobre operações de antecipação de clientes |
assignment-coobligation.analyzed | Resultado da análise de crédito do fornecedor |
Os payloads disponíveis abaixo representam o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.
receivables.changed-status
{
"id": 0,
"recebivelId": "qM76xAd0CkqKR24CUE7DZg==",
"payerTaxId": "string",
"payeeTaxId": "string",
"maturityDate": "2023-11-30",
"trades": [
{
"id": "string"
}
],
"statusRecebivel": "Aprovado",
"motivos": [
"string"
],
"invoiceIdentification": "string",
"nettedPaymentIdentification": "string",
"eventTimestamp": "2023-11-30T12:35:00.863Z"
}assignment-coobligation.converted-operation
{
"taxId": "00.006.000/0001-00",
"updatedAt": "2023-03-13T18:43:42.918Z",
"operations": [
{
"externalId": "string",
"product": "CessaoCoobrigacao",
"disbursementDate": "string",
"settlementDate": "string",
"disbursementAmount": "string",
"invoiceAmount": "string",
"status": "EXPT",
"cardFlag": "MasterCard",
"acquirer": {
"name": "string",
"cnpj": "string"
},
"bankAccount": {
"bank": "string",
"agency": "string",
"account": "string"
}
}
}assignment-coobligation.analyzed
{
"customerId": "00.006.000/0001-00",
"productLimit": 0,
"productType": "cessaoComCoobrigacao",
"limitDateExpire": "2023-03-13",
"effectiveness": "PreApproved",
"productInformation": {
"minTradeValue": 0,
"maxTradeValue": 0,
"originId": "c3bfc6a5-7142-4f06-b0f0-c85185c1b5ab",
"drawees": [
"1234567890123, 1234567890123, 1234567890123"
]
}