Os sistemas BTG Pactual Empresas fazem a segurança a nível de usuário, ou seja, utilizamos as permissões que o usuário concede para decidir ao que o seu sistema terá acesso na conta daquele usuário específico.

Ao mesmo tempo, precisamos saber ao que o seu sistema tem acesso, para que possamos garantir a integridade dos serviços e aumentar a segurança do usuário final.

Para servir estas duas funções implementamos os escopos.

openid

O escopo openid é obrigatório para, efetivamente, todos os serviços da API de banking. Logo, tenha em mente que ele precisará sempre estar incluso no seu fluxo.

Alguns casos específicos, como o fluxo de client credentials, não necessitam desse escopo.

readonly

Os escopos com .readonly são escopos que permitem apenas os métodos de leitura e listagem.

Escopos e seus usos

Aqui você encontrará uma relação entre os escopos e os serviços que ele representam

EscopoEndpointProduto
openidTodosEscopo base de auth code flow
empresas.btgpactual.com/accounts/v1/accounts/...Consulta de saldo e extrato
empresas.btgpactual.com/bank-slips/v1/bank-slips/...Geração, consulta e cancelamento de boletos
empresas.btgpactual.com/pix-cash-in/v1/companies/{companyId}/pix-cash-in/...Geração de QR code e cobrança pix com QR code
empresas.btgpactual.com/payments/v1/companies/{companyId}/payments/...Criação, agendamento e cancelamento de pagamentos.
empresas.btgpactual.com/transfers/v1/companies/{companyId}/transfers/...Criação, agendamente e cancelamento de pagamentos.
empresas.btgpactual.com/authorized-direct-debits.readonly/v1/companies/{companyId}/authorized-direct-debits/...Consulta de DDA
empresas.btgpactual.com/solar-credit/v1/solar/...Consulta e cadastro de crédito solar.
empresas.btgpactual.com/files/v1/v1/filesArmazenamento de arquivos na cloud.
empresas.btgpactual.com/scf/borderos/v1/scf/borderos/...Criação, consulta e cancelamento de borderos.
empresas.btgpactual.com/scf/companies/v1/scf/companies/{payerTaxId}/payees/...Cadastro e consulta de fornecedores.
empresas.btgpactual.com/scf/operations/v1/scf/operations/...Criação e consulta de operações de recebíveis
empresas.btgpactual.com/scf/settlements/v1/scf/settlements/...Criação e consulta de pedidos de liquidação.
empresas.btgpactual.com/scf/trades.readonly/v1/scf/trades/,,,Consulta de carteira de operações e posição em trades.