Conta Digital Pessoa Jurídica

Consulte saldos e extratos e receba notificações de movimentações

Suggest Edits

A API de Conta Digital Pessoa Jurídica permite que você consulte saldos e extratos das suas contas, além de receber notificações de movimentações.

Casos de Uso

  • Consulta de Saldo e Extrato
  • Conciliação de Pagamentos

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 Conta Pessoal Pessoa Jurídica 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/accounts.readonlyPermite consulta de saldo, extrato, dados da conta PJ e recebimento de webhooks.

Recursos Disponíveis

Os recursos da API de Conta Digital PJ estão estão disponíveis no API Reference.

📘

API Reference

Conta Digital PJ

Eventos

A API de Conta Digital PJ disponibiliza os seguintes eventos de webhook:

transaction.credit

Crédito na conta.

{
  "accountId": "25257331000132-208-50-003633854",
  "date": "2023-04-10T13:47:16.146Z",
  "creditDebitIndicator": "CREDIT",
  "amount": 65,
  "currency": "BRL",
  "transactionId": "10000000000",
  "type": "Pix",
  "reason": "",
  "relatedParty": {
    "taxId": "03000000000",
    "bankCode": "000",
    "name": "PEDRO ALVARES CABRAL",
    "currency": "BRL",
    "branchCode": "1000",
    "number": "00000000000000000"
  },
  "payload": {
    "txId": "PIXyz2K7jSRdnDXu9OM09CDdJ",
    "endToEndId": "E00360305202304101345201fa2cd0f3"
  },
  "description": "Pix recebido de PEDRO ALVARES CABRAL PIXyz2K7jSRdnDXu9OM09CDdJ"
}

transation.debit

Débito na conta.

{
  "accountId": "25257331000132-208-50-003633854",
  "date": "2023-04-10T13:47:16.146Z",
  "creditDebitIndicator": "DEBIT",
  "amount": 65,
  "currency": "BRL",
  "transactionId": "10000000000",
  "type": "Pix",
  "reason": "",
  "relatedParty": {
    "taxId": "03000000000",
    "bankCode": "000",
    "name": "PEDRO ALVARES CABRAL",
    "currency": "BRL",
    "branchCode": "1000",
    "number": "00000000000000000"
  },
  "payload": {
    "txId": "PIXyz2K7jSRdnDXu9OM09CDdJ",
    "endToEndId": "E00360305202304101345201fa2cd0f3"
  },
  "description": "Pix recebido de PEDRO ALVARES CABRAL PIXyz2K7jSRdnDXu9OM09CDdJ"
}

balance.avaliable

Recursos disponíveis na conta. 

{

  "eventId": "balance.available",

  "metadataId": "50571800000130-208-50-004546948",

  "tenantId": "50000000000000",

  "message": {

    "accountId": "50571800000130-208-50-004546948",

    "bankCode": "000",

    "taxId": "50000000000000",

    "branchCode": "00",

    "number": "000000008",

    "timestamp": "2023-05-09T14:35:52.630961957Z",

    "available": { "amount": 2046 }

  }

}

Updated 27 days ago