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 saldo e extrato compatível com open finance deve ser gerado usando o Authorization Code.
É necessário informar os seguintes escopos na realização do fluxo:
| Escopo | Descrição |
|---|---|
| empresas.btgpactual.com/accounts.readonly | Acesso a dados de conta BTG. |
| brn:btg:empresas:openfinance:accounts:info.readonly | Acesso base aos recursos de open finance da conta. |
| brn:btg:empresas:openfinance:accounts:balances.readonly | Acesso aos recursos de open finance de saldo da conta. |
Como eu utilizo?
Antes do cliente conceder permissão a aplicação que irá consultar o saldo nas instituições financeiras, será necessário autorizar o compartilhamento de seus dados com BTG Pactual através da área de consentimento
A utilização da integração é muito simples tanto para você cliente que está construindo sua integração quanto para você cliente que já possui uma integração previamente construída.
Para consumir os dados de contas, basta que chame o endpoint de Consultar dados da conta passando como um query param accountOrigin com valor OPEN_FINANCE para que obtenha os dados de suas contas no open finance.
Para consumir saldo e extrato, a API é a mesma utilizada pelo Saldo e Extrato , porém deve ser informado o accountId de uma conta do open finance
Eventos de webhook
Os payloads disponíveis abaixo representam o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.
| Eventos | Descrição |
|---|---|
openfinance-transactions.credit | Crédito em conta no open finance |
openfinance-transaction.debit | Débito em conta no open finance |
openfinance-transactions.credit
{
"accountId": "31333096000333-333-1-3333334033301333333",
"amount": 1,
"creditDebitIndicator": "CREDIT",
"currency": "BRL",
"date": "2025-02-12T18:13:16.000Z",
"description": "Outros",
"relatedParty": {
"currency": "BRL"
},
"taxId": "31333096000333",
"transactionId": "3e3bfc3e-3333-3301-3336-3333c33a33ca",
"type": "Outros",
"tenantId": "31333096000333"
}openfinance-transactions.debit
{
"accountId": "31333096000333-333-1-3333334033301333333",
"amount": 1,
"creditDebitIndicator": "DEBIT",
"currency": "BRL",
"date": "2025-02-12T18:13:16.000Z",
"description": "Outros",
"relatedParty": {
"currency": "BRL"
},
"taxId": "31333096000333",
"transactionId": "3e3bfc3e-3333-3301-3336-3333c33a33ca",
"type": "Outros",
"tenantId": "31333096000333"
}