Cessão com Coobrigação

Antecipe pagamentos com crédito aos fornecedores

Suggest Edits

A API de Cessão com Coobrigação permite que você ofereça a seus fornecedores a antecipação do pagamento como crédito, utilizando o limite disponibilizado para eles. Esta API também permite a avaliação de crédito e cadastro de fornecedores.

Casos de Uso

  • Integrar antecipação de recebíveis a uma plataforma.
  • Integrar avaliação de crédito a uma plataforma.
  • Cadastro de fornecedores numa plataforma.

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 Cessão com Coobrigação deve ser gerado usando o Client Credentials.

É necessário escolher um dos seguintes escopos:

EscopoDescrição
empresas.btgpactual.com/assignment-coobligationPermite gerenciar limites e conjuntos de recebíveis (borderôs) para cessão com coobrigação.
empresas.btgpactual.com/assignment-coobligation.readonlyPermite consultar limites e conjuntos de recebíveis (borderôs) para cessão com coobrigação.

Recursos Disponíveis

Os recursos da API de Cessão com Coobrigação estão disponíveis no API Reference.

📘

API Reference

Cessão com Coobrigação

Eventos

A API de Cessão com Coobrigação 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": [
    "00.006.000/0001-00"
  ],
  "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"
  
}
}

Operações

Informações sobre operações de antecipação de clientes.

{
    "webhookId": "bb2ae4c5-8094-4f3c-b0e0-02646ba6e5e3",
    "event": "assignment-coobligation.converted-operation",
    "data": {
  "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"
      }
    }

Análise de crédito

Resultado da análise de crédito do fornecedor. 

{
    "webhookId": "bb2ae4c5-8094-4f3c-b0e0-02646ba6e5e3",
    "event": "assignment-coobligation.analyzed",
    "data": {
  "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"
    ]
  }
}

Updated 3 months ago