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

Risco Sacado

Antecipe pagamentos a fornecedores com seu limite de crédito

Suggest Edits

Se a sua empresa trabalha com antecipação de recebíveis para um volume grande de fornecedores, a API de Risco Sacado permite que você utilize o seu limite de crédito para antecipar pagamentos a fornecedores.

Casos de Uso

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:

EscopoDescrição
empresas.btgpactual.com/scf/borderosPermite criar e consultar conjuntos de recebíveis (borderôs).
empresas.btgpactual.com/scf/borderos.readonlyPermite consultar conjuntos de recebíveis (borderôs).
empresas.btgpactual.com/scf/companiesPermite consultar fornecedores.
empresas.btgpactual.com/scf/companies.readonlyPermite cadastrar e consultar fornecedores.
empresas.btgpactual.com/scf/operationsPermite criar e consultar operação de antecipação de recebíveis.
empresas.btgpactual.com/scf/operations.readonlyPermite consultar operação de antecipação de recebíveis.
empresas.btgpactual.com/scf/settlementsPermite cadastrar e consultar pagamento de recebíveis antecipados .
empresas.btgpactual.com/scf/settlements.readonlyPermite consultar pagamento de recebíveis antecipados .

Recursos Disponíveis

Os recursos da API de Risco Sacado estão disponíveis no API Reference.

📘

API Reference

Risco Sacado

Eventos

A API de Risco Sacado disponibiliza os seguintes eventos de webhook:

Curva de taxas

Envia informações das taxas de juros ao longo do tempo. 

{
    "webhookId": "bb2ae4c5-8094-4f3c-b0e0-02646ba6e5e3",
    "event": "PublishFees",
    "data": {
      "taxIds": [
        "15.996.430/0001-82"
      ],
      "product": "Cartao",
      "strategyId": "string",
      "strategyName": "string",
      "currency": "BRL",
      "feesCurve": [
        {
          "baseDate": "2023-03-13",
          "settlementDate": "2023-03-13",
          "monthlyFee": 0,
          "totalFee": 0
        }
      ]
    }   
}

Status do recebível

Envia informações sobre o status de um recebível. 

{
    "webhookId": "bb2ae4c5-8094-4f3c-b0e0-02646ba6e5e3",
    "event": "receivables.changed-status",
    "data": {
      "id": 0,
      "recebivelId": "qM76xAd0CkqKR24CUE7DZg==",
      "trades": [
        {
          "id": "string",
          "status": "string"
        }
      ],
      "statusRecebivel": "Aberto",
      "motivos": [
        "string"
      ],
      "invoiceIdentification": "string",
      "nettedPaymentIdentification": "string",
      "eventTimestamp": "2023-03-13T18:06:07.046Z"
    }
}

Updated 12 months ago