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 Saldo e Extrato deve ser gerado usando o Authorization Code.
O escopo openidé obrigatório. Ele permite consultar o perfil do usuário BTG com acesso à conta.
| Escopo | Descrição |
|---|---|
empresas.btgpactual.com/accounts.readonly | Permite consulta de saldo, extrato, dados da conta PJ e recebimento de webhooks. |
Eventos de webhook
Os payloads disponíveis abaixo representam o conteúdo do campo data, seguindo o formato do envio descrito em Eventos.
| Evento | Descrição |
|---|---|
transactions.credit | Crédito em conta |
transactions.debit | Débito em conta |
balance.avaliable | Saldo disponível em conta |
transactions.credit
{
"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"
}transactions.credit (boleto)
{
"accountId": "25257331000132-208-50-003633854",
"date": "2023-04-10T13:47:16.146Z",
"creditDebitIndicator": "CREDIT",
"amount": 65,
"currency": "BRL",
"transactionId": "10000000000",
"type": "Bankslip",
"febrabanCode":"202",
"reason": "",
"relatedParty": {
"taxId": "03000000000",
"bankCode": "000",
"name": "PEDRO ALVARES CABRAL",
"currency": "BRL",
"branchCode": "1000",
"number": "00000000000000000"
},
"payload": {
"barcode": "99899993400000990000099999999050039009999990",
"ourNumber": "37726891180500390"
},
"description":"Boleto pago PEDRO ALVARES CABRAL"
}transactions.debit
{
"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
{
"accountId": "500000000000-000-00-000000008",
"bankCode": "000",
"taxId": "50000000000000",
"branchCode": "00",
"number": "000000008",
"timestamp": "2023-05-09T14:35:52.630961957Z",
"available": { "amount": 2046 }
}