Saltar al contenido principal

Ficha técnica

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.

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 cadastrar e consultar fornecedores.
empresas.btgpactual.com/scf/companies.readonlyPermite 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/receivablesPermite enviar documentos relacionados a recebíveis.
empresas.btgpactual.com/scf/receivables.readonlyPermite consultar informações relacionadas a 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.
empresas.btgpactual.com/scf/tradesPermite consultar antecipações de recebíveis.
empresas.btgpactual.com/scf/trades.readonlyPermite consultar antecipações de recebíveis em modo somente leitura.

Recursos Disponíveis​

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

📘 API Reference

Risco Sacado

Eventos de webhook​

Os payloads disponíveis abaixo representam o conteúdo do campo data.

EventoDescrição
receivables.calculated-feesCurva de taxas publicada ou atualizada.
receivables.changed-statusStatus de um recebível atualizado.

receivables.calculated-fees​

{
"taxIds": [
"00006000000100"
],
"product": "Cartao",
"strategyId": "72e4d0db-841c-4bcd-9750-98e333507f67",
"strategyName": "Estratégia padrão",
"currency": "BRL",
"feesCurve": [
{
"baseDate": "2026-08-12",
"settlementDate": "2026-09-12",
"monthlyFee": 0.0125,
"totalFee": 0.0125
}
]
}

receivables.changed-status​

{
"id": 0,
"identification": "5120070562",
"trades": [
{
"id": "string",
"contractNumber": "123-12345",
"disbursedAmount": 0,
"disbursementDate": "2026-08-21"
}
],
"maturityDate": "2026-08-21",
"status": "Aprovado",
"payeeTaxId": "string",
"payerTaxId": "string",
"borderoTrackingId": "3382cc6f-1c59-4423-b364-c837deaf110d",
"motivos": ["string"],
"invoiceIdentification": "string",
"nettedPaymentIdentification": "string",
"eventTimestamp": "2026-08-21T18:41:33.159Z"
}