BTG Pactual Empresas
Objetivo
Integração com a API do BTG Pactual Empresas para automação de boletos, pagamentos, Pix, extratos, débitos e links de pagamento. Permite realizar e consultar transações financeiras, emitir cobranças e acessar dados bancários empresariais.
Criando um fluxo
- Acesse Fluxos na plataforma Fluid.
- Clique em Criar fluxo e selecione o conector BTG Pactual Empresas.
- Nomeie o fluxo e clique em Avançar.
Criando conexão
Para autenticar:
- ID do Cliente (obrigatório): fornecido pelo BTG.
- Chave Secreta do Cliente (obrigatório): fornecida pelo BTG.
- Escopo (opcional): define permissões específicas.
- Ambiente (obrigatório): escolha entre sandbox ou produção.
- Tipo de Conexão (obrigatório): escolha entre authorization_code e client_credentials.
- authorization_code é necessário para acessar os recursos de Boletos, Pagamentos, Pix Cobrança, Saldo e Extrato, Débito Direto e Autorizado, Link de pagamento e Antecipação de cartão de crédito - client_credentials é necessário para acessar o recurso de Leads de crédito
Ao escolher o tipo de authenticação "authorization_code" será necessário efetuar o login na plataforma, e para isso, adicione a seguinte uri de redirecionamento da Fluid no seu aplicativo da BTG: https://console.fluidapi.io
Configurando fluxo
Escolha um dos recursos disponíveis e selecione a operação desejada. Cada operação exige parâmetros obrigatórios específicos. Abaixo, listamos os recursos disponíveis.
Recursos e Operações
Recurso: Boletos
Operações:
- Listar boletos: Consulta boletos registrados.
- Obrigatórios: Identificador da conta, Identificador único do boleto
- Opcionais: OffSet, Limite
- Criar boleto: Emissão individual de boleto.
- Obrigatórios: Identificador da conta, Selecione como deseja fazer essa operação
- O body pode ser preenchido via campos dinâmicos ou template. Nos campos dinâmicos:
- Valor da cobrança, Data de vencimento do boleto, Número de referencia, Número de parcelas são requeridos.
- Criar boletos em lote: Envio de múltiplos boletos via template ou mapeamento De/Para.
- Obrigatórios: Identificador da conta, Corpo da requisição
- Atualizar um boleto: Altera dados de um boleto existente.
- Obrigatórios: Identificador único do boleto, Identificador da conta, Valor da cobrança, Data de vencimento do boleto
- Cancelar boleto: Remove um boleto emitido.
- Obrigatórios: Identificador único do boleto, Identificador da conta
- Listar boletos PDF: Gera versão PDF de boletos emitidos.
- Obrigatórios: Identificador da conta
- Opcionais: Identificador único do boleto, Código de barras, Linha digitável
Recurso: Pagamentos
Operações:
- Criar iniciação de pagamento ou transferência
- Obrigatórios: CNPJ da empresa, Corpo da requisição
- Listar iniciações
- Obrigatórios: CNPJ da empresa, Tamanho da Pagina, Numero da Pagina
- Consultar pagamento específico
- Obrigatórios: CNPJ da empresa, Id Pagamento, Corpo da requisição
- Cancelar pagamento agendado
- Obrigatórios: CNPJ da empresa, Id Pagamento
- Consulta por código de barras
- Obrigatórios: CNPJ da empresa, Código de barras, Tamanho da Pagina, Numero da Pagina
- Cancelar pagamento pendente de aprovação
- Obrigatórios: CNPJ da empresa, Id Pagamento
- Obter recibo
- Obrigatórios: CNPJ da empresa, Id Pagamento
Recurso: Pix Cobrança
Operações:
- Obter lista de QR Codes
- Obrigatórios: CNPJ da empresa
- Criar QR Code
- Obrigatórios: CNPJ da empresa, Tipo
- Desvincular QR Code
- Obrigatórios: CNPJ da empresa, locationId
- Obter lista de cobranças
- Obrigatórios: CNPJ da empresa
- Opcionais: locationId, Data inicial, Data final, Apenas Ativos
- Criar cobrança
- Obrigatórios: CNPJ da empresa, Chave pix, valor da cobrança
Recurso: Saldo e Extrato
Operações:
- Consultar conta por AccountId
- Obrigatórios: Identificador da Conta
- Consultar saldo
- Opcionais: Identificador da Conta
- Consultar extrato por AccountId
- Obrigatórios: Identificador da Conta
- Opcionais: Data Inicial, Data Final, Tipo
- Consultar contas com acesso concedido
- Opcionais: Origem
- Obter extrato PDF
- Obrigatórios: CNPJ da empresa, Identificador da Conta, Data Inicial, Data Final, Ordem de listagem, Tipo
Recurso: Débito Direto e Autorizado
Operações:
- Consultar débitos autorizados
- Obrigatórios: CNPJ da empresa
- Opcionais: status
- Verificar débito autorizado específico
- Obrigatórios: CNPJ da empresa, Identificador de débito direto autorizado
Recurso: Link de pagamento
Operações:
- Criar link
- Obrigatórios: CNPJ da empresa, origem
- Listar links
- Obrigatórios: CNPJ da empresa, Quantidade de cobranças por página, Número da página
- Vários filtros opcionais por data, valor, status, tipo
- Atualizar link
- Obrigatórios: CNPJ da empresa, Identificador do Link de Pagamento
- Cancelar link
- Obrigatórios: CNPJ da empresa, Identificador do Link de Pagamento
- Listar cobranças de um link
- Obrigatórios: CNPJ da empresa, Quantidade de cobranças por página, Número da página, Identificador do Link de Pagamento
Recurso: Leads de crédito
Operações:
- Solicitação de crédito
- Obrigatórios: CPF do operador, CNPJ do cliente, Identificador único fornecido pelo parceiro, Faturamento médio mensal e Linhas de créditos solicitadas no envio da análise
Recurso: Antecipação de cartão de crédito
Operações:
- Antecipação de recebíveis
- Obrigatórios: CNPJ da empresa, Codigo do banco, Agência da conta, Número da conta e Dígito da conta
- Visualizar contas de desembolso
- Obrigatórios: CNPJ da empresa
- Consulta de operações
- Obrigatórios: CNPJ da empresa e Identificador dos recebíveis e operações
- Consulta de valores para antecipar
- Obrigatórios: CNPJ da empresa
- Resumo do saldo devedor
- Obrigatórios: CNPJ da empresa
- Listagem de recebíveis
- Obrigatórios: CNPJ da empresa
- Busca recebíveis por parâmetros de busca
- Obrigatórios: CNPJ da empresa
Na prática
Neste tópico criaremos um fluxo utilizando o conector BTG Pactual Empresas. O fluxo terá somente um passo, onde o objetivo será criar uma iniciação de pagamento ou transferência.
Passo iniciacao-pagamento
Assim ficará a Parametrização do nosso primeiro passo:
Na aba Propriedades informamos o nome do passo e a conexão criada para o BTG Pactual Empresas:
Disparando o Fluxo
Com os passos configurados basta disparar o fluxo. Nesse caso não precisaremos informar um payload de entrada, pois os dados que estamos usando no exemplo estão fixos no conector. Após o disparo, o resultado do fluxo será apresentado em tempo real no canvas:
Conclusão
O conector BTG Pactual Empresas na plataforma Fluid oferece ampla cobertura de funcionalidades financeiras empresariais. Permite automação robusta de cobranças, pagamentos, extratos e integrações com Open Finance e Pix.