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

Débito Direto Autorizado (DDA)

Permite consultar boletos emitidos para um CNPJ

Suggest Edits

A API de Débito Direto Autorizado permite que você consulte boletos emitidos de qualquer empresa para um CNPJ específico. Além disso, você pode consultar boletos em aberto ou pagos separados por períodos. Qualquer boleto bancário, como aluguéis, seguros, planos de saúde, contas de cartão de crédito, etc, pode ser consultado. Boletos não bancários, como contas de consumo (água, luz, gás) ou impostos (IPTU, IPVA, ITR, etc) não podem ser consultados.

*Para consumir esta API, você precisa contratar o serviço de Débito Direto Autorizado.

*O serviço de DDA é desabilitado a partir de 60 dias da adesão ou do último pagamento caso a conta BTG Empresas não seja utilizada

Boletos recorrentes, cuja linha digitável não muda mês a mês, ainda não são monitorados pelo serviço de DDA

Casos de Uso

  • Concentrar a consulta de boletos numa única plataforma.
  • Notificar usuários sobre boletos em aberto.
  • Inserir num serviço informações de cobrança.

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 Débito Direto Autorizado (DDA) deve ser gerado usando o Authorization Code.

O escopo openidé obrigatório. Ele permite consultar o perfil do usuário BTG com acesso à conta.

EscopoDescrição
empresas.btgpactual.com/authorized-direct-debitsPermite a consulta de boletos para o CNPJ

Recursos Disponíveis

Os recursos da API Débito Direto Autorizado (DDA) estão disponíveis no API Reference.

📘

API Reference

Débito Direto Autorizado (DDA)

Eventos

A API Débito Direto Autorizado (DDA) disponibiliza os seguintes eventos de webhook:

DDA Habilitado

Notifica quando o DDA é habilitado.

{
    "webhookId": "bb2ae4c5-8094-4f3c-b0e0-02646ba6e5e3",
    "event": "transactions.debit",
    "data": {
        "accountId": "37297902000141-208-50-003886850",
        "date": "2022-03-02T22:01:55.274Z",
        "creditDebitIndicator": "DEBIT",
        "amount": 30900,
        "currency": "BRL",
        "transactionId": "33449743"
    }
}

DDA Desabilitado

Notifica quando o DDA é desabilitado.

{
  "webhookId": "00000000-0000-0000-0000-1d856e915a8f",
  "event": "authorized-direct-debits.disabled",
  "data": {
    "directDebitId": "00000000-8bcf-488b-85f9-8b3a041e3eef",
    "owner": {
      "taxId": "30306294000145",
      "name": "NOME EMPRESA"
    },
    "status": "DISABLED"
  }

Débito Emitido

Notifica quando há um novo débito para o CNPJ.

{
  "webhookId": "00000000-0000-0000-0000-1d856e915a8f",
  "event": "authorized-direct-debits.debit-added",
  "data": {
    "directDebitId": "00000000-7779-4f25-bec0-ebb3391589be",
    "owner": {
      "taxId": "30306294000145",
      "name": "NOME EMPRESA"
    },
    "status": "ENABLED",
    "debits": [
      {
        "id": "00000000-0000-0000-0000-c35ba9199d96",
        "amount": 24193.61,
        "dueDate": "2023-03-16",
        "expirationDate": "2024-03-16",
        "digitableLine": "20800000000000000000000000000000000000000004800",
        "status": "CREATED",
        "payee": {
          "taxId": "30306294000145",
          "socialName": "Emiss_o Boleto BTG",
          "fantasyName": "Emiss_o Boleto BTG",
          "bank": {
            "code": "208",
            "name": "BANCO BTG PACTUAL S.A."
          }
        }
      },
      {
        "id": "00000000-0000-0000-0000-c35ba9199d97",
        "amount": 24193.61,
        "dueDate": "2023-03-16",
        "expirationDate": "2024-03-16",
        "digitableLine": "20800000000000000000000000000000000000000004800",
        "status": "CREATED",
        "payee": {
          "taxId": "30306294000145",
          "socialName": "Emiss_o Boleto BTG",
          "fantasyName": "Emiss_o Boleto BTG",
          "bank": {
            "code": "208",
            "name": "BANCO BTG PACTUAL S.A."
          }
        }
      }
    ]
  }
}

Débito Pago

Notifica quando um débito é pago.

{
  "webhookId": "00000000-0000-0000-0000-1d856e915a8f",
  "event": "authorized-direct-debits.debit-paid",
  "data": {
    "directDebitId": "00000000-0000-0000-0000-ebb3391589be",
    "owner": {
      "taxId": "00000000000001",
      "name": "NOME EMPRESA"
    },
    "status": "ENABLED",
    "debits": [
      {
        "id": "00000000-0000-0000-0000-c35ba9199d97",
        "amount": 4948.1,
        "dueDate": "0001-01-01",
        "expirationDate": "0001-01-01",
        "digitableLine": "20800000000000000000000000000000000000000004800",
        "status": "PAID",
        "payee": {
          "taxId": "00000000000001",
          "socialName": "SOCIAL NAME",
          "fantasyName": "NAME",
          "bank": {
            "code": "208",
            "name": "BANCO BTG PACTUAL S.A."
          }
        }
      }
    ]
  }
}

Updated 7 months ago