APIs e integrações
APIs financeiras na prática: casos de uso e exemplos de integração com as APIs do Efí Bank
Antes de escolher uma API, a empresa precisa definir qual experiência quer oferecer ao cliente e quais processos financeiros precisa automatizar.
Recebimento imediato, parcelamento, recorrência e divisão de valores, por exemplo, funcionam de formas diferentes. Por isso, antes de escolher quais APIs financeiras integrar, é importante entender qual problema a tecnologia precisa resolver.
Neste guia, reunimos diferentes cenários e mostramos quais recursos do Efí Bank podem atender a cada um deles.
Como escolher uma integração a partir da jornada de pagamento?
Uma boa arquitetura de pagamentos considera fatores como meio de pagamento, prazo de recebimento, recorrência, número de participantes e experiência desejada no checkout.
No Efí Bank, a API Pix concentra recursos relacionados ao Pix, enquanto a API Pix via Open Finance permite iniciar pagamentos com uma jornada reduzida. Já boleto, cartão, carnê, assinatura, link de pagamento e outros recursos fazem parte da API Cobranças.
Veja alguns cenários.
1. Recebimento instantâneo: Pix com QR Code ou Pix Copia e Cola
Problema resolvido: automatizar cobranças Pix e identificar cada pagamento dentro do sistema.
Perfil de operação: e-commerces, aplicativos, ERPs, plataformas SaaS, PDVs e sistemas que precisam conciliar pagamentos automaticamente.
A API Pix permite criar cobranças imediatas, chamadas de Pix Cob, ou cobranças com vencimento, conhecidas como Pix CobV. Elas podem ser apresentadas como QR Code ou Pix Copia e Cola.
Fluxo:
- o sistema cria a cobrança;
- a API retorna os dados do Pix;
- o cliente paga;
- o sistema recebe a confirmação e atualiza o pedido.
Exemplo oficial de integração Pix do Efí Bank antes da emissão da cobrança.
No exemplo oficial do Efí Bank, a criação da cobrança começa pelo preenchimento das informações da operação, como descrição, valor, dados do cliente e tempo de expiração. Após a emissão, a integração pode disponibilizar os dados necessários para o pagamento via Pix.
Pré-requisitos: conta Efí Bank, aplicação com API Pix habilitada, escopos correspondentes, Client_Id Client_Secret, certificado e chave Pix registrada na conta.
Ver exemplo oficial de integração Pix
Consultar documentação de cobranças Pix
2. Pix via Open Finance: pagamento simplificado e automático
Problema resolvido: reduzir etapas entre a escolha do Pix e a autorização do pagamento.
Perfil de operação: apps, marketplaces e e-commerces em que a experiência de checkout é parte relevante da conversão.
Com a API Pix via Open Finance, o cliente escolhe a instituição financeira e segue para a autorização do pagamento dentro da jornada iniciada pelo site ou aplicativo. O Efí Bank atua como iniciador de pagamentos autorizado pelo Banco Central.
Fluxo:
- o cliente seleciona Pix via Open Finance;
- escolhe sua instituição;
- é direcionado para autorizar a operação;
- o pagamento é concluído.
Exemplo oficial da integração Pix via Open Finance do Efí Bank, com configuração de pagamento automático, recorrência e instituição financeira.
No exemplo oficial do Efí Bank, o Pix via Open Finance permite configurar uma autorização de Pix Automático. A tela reúne dados do pagamento, informações do cliente, frequência da recorrência, período das cobranças e a instituição financeira em que a autorização será feita.
Pré-requisitos: conta Efí Bank, aplicação com API Open Finance habilitada, escopos correspondentes, credenciais e certificado.
Ver exemplo de Pix via Open Finance
Consultar documentação de Open Finance
3. Parcelamento no crédito: cartão em até 12x
Problema resolvido: oferecer parcelamento dentro da jornada digital.
Perfil de operação: e-commerces, sistemas de vendas e plataformas que precisam incorporar cartão ao próprio checkout.
A integração permite criar cobranças e oferecer pagamento no cartão de crédito em até 12 parcelas.
Fluxo:
- o sistema cria a cobrança;
- envia os dados necessários;
- associa o cartão à transação;
- acompanha seu status.
Exemplo oficial de integração com cartão de crédito do Efí Bank, com preenchimento dos dados da compra, do cliente e do pagamento antes da definição das parcelas.
No exemplo oficial do Efí Bank, a integração com cartão reúne dados do produto, informações do cliente, endereço e dados de pagamento. Depois dessa etapa, o sistema permite definir o número de parcelas da cobrança.
Pré-requisitos: conta Efí Bank, aplicação com API de Emissões habilitada, escopo da API Cobranças e credenciais Client_Id e Client_Secret.
Ver exemplo de integração com cartão
4. Alto ticket parcelado sem cartão: carnê
Problema resolvido: dividir uma compra de maior valor sem depender do limite do cartão.
Perfil de operação: serviços, educação, vendas B2B e operações com pagamentos programados.
O carnê permite gerar, de uma só vez, as diferentes cobranças relacionadas ao parcelamento. No exemplo oficial, é possível configurar até 24 parcelas.
Fluxo:
- defina o cliente;
- valor e quantidade de parcelas;
- gere o carnê;
- entregue as cobranças;
- acompanhe os pagamentos.
Exemplo oficial de integração de carnê do Efí Bank, com configuração do valor, dados do cliente, vencimento e quantidade de parcelas.
No exemplo oficial do Efí Bank, a emissão do carnê reúne os dados do produto e do cliente, a data de vencimento e o número de parcelas. Também é possível incluir instruções adicionais antes da emissão da cobrança.
Pré-requisitos: conta Efí Bank, aplicação com API de Emissões habilitada, escopo da API Cobranças e credenciais Client_Id e Client_Secret.
Ver exemplo de integração com carnê
5. Boleto + Pix na mesma cobrança: Bolix
Problema resolvido: evitar que a empresa tenha de emitir uma cobrança diferente para cada forma de pagamento.
Perfil de operação: empresas que trabalham com boleto, mas querem oferecer uma opção de liquidação via Pix.
O Bolix combina código de barras e QR Code Pix na mesma cobrança. Assim, o cliente escolhe como prefere pagar.
Fluxo:
- o sistema gera a cobrança;
- recebe os dados do Bolix;
- apresenta o documento ao cliente;
- acompanha a confirmação.
Exemplo oficial de integração de boleto do Efí Bank, com preenchimento dos dados da cobrança, do cliente e da data de vencimento.
No exemplo oficial do Efí Bank, a emissão do boleto começa com o preenchimento das informações do produto, do cliente e da data de vencimento. A partir desses dados, a aplicação pode gerar a cobrança e acompanhar seus status.
Pré-requisitos: conta Efí Bank, aplicação com API de Emissões habilitada, escopo da API Cobranças e credenciais Client_Id e Client_Secret.
6. Cobranças periódicas: assinatura e recorrência
Problema resolvido: deixar de criar manualmente uma nova cobrança a cada ciclo.
Perfil de operação: SaaS, clubes, escolas, serviços profissionais e negócios de assinatura.
Na API Cobranças, a empresa pode criar um plano, definir periodicidade e vincular assinaturas a ele. As cobranças recorrentes podem ocorrer por cartão ou boleto.
Fluxo:
- crie o plano;
- defina periodicidade e repetições;
- vincule o cliente;
- configure a forma de pagamento;
- acompanhe as cobranças.
Exemplo oficial de integração de assinatura do Efí Bank, com definição do plano, periodicidade da cobrança, dados do cliente e forma de pagamento.
No exemplo oficial do Efí Bank, a assinatura é configurada a partir do nome do plano, da periodicidade da cobrança, dos dados do produto e do cliente. A interface também permite escolher entre boleto e cartão de crédito e definir a data de vencimento.
Pré-requisitos: conta Efí Bank, aplicação com API de Emissões habilitada, escopo da API Cobranças e credenciais Client_Id e Client_Secret.
Consultar documentação de assinaturas
7. Cobrar sem desenvolver checkout próprio: link de pagamento
Problema resolvido: receber online sem precisar construir uma interface de checkout.
Perfil de operação: plataformas, times comerciais, vendas assistidas e projetos que precisam validar rapidamente uma jornada de pagamento.
A API permite gerar uma página de pagamento hospedada pelo Efí Bank e definir as formas disponíveis ao cliente.
Fluxo:
- crie a cobrança;
- configure os meios aceitos;
- gere o link;
- compartilhe com o cliente.
Exemplo oficial de integração de Link de Pagamento do Efí Bank, com configuração do produto, vencimento, mensagem ao pagador e meios de pagamento disponíveis.
No exemplo oficial do Efí Bank, o Link de Pagamento é criado a partir dos dados do produto e de configurações da cobrança. A empresa pode definir o vencimento, incluir uma mensagem ao pagador, pedir endereço de entrega e selecionar meios de pagamento disponíveis.
Pré-requisitos: conta Efí Bank, aplicação com API de Emissões habilitada, escopo da API Cobranças e credenciais Client_Id e Client_Secret.
Ver exemplo de link de pagamento
Consultar documentação do link de pagamento
8. Repasse entre participantes: Split de Pagamento
Problema resolvido: automatizar a divisão do valor recebido entre diferentes participantes.
Perfil de operação: marketplaces, plataformas, redes de serviços e modelos com comissionamento.
Na API Cobranças, o split pode distribuir valores entre contas Efí Bank, usando percentual ou valor definido na transação. A documentação informa que não há limite máximo de contas participantes no repasse.
Fluxo:
- defina participantes e regras;
- crie a transação;
- associe a forma de pagamento;
- acompanhe cobrança e repasses.
Exemplo oficial de integração de Split de Pagamento do Efí Bank, com configuração dos participantes, percentuais de repasse e informações da cobrança.
No exemplo oficial do Efí Bank, o Split de Pagamento permite configurar os participantes que receberão parte da transação. Para cada conta, são informados o identificador payee_code e o percentual de repasse, além dos dados do cliente e do pagamento.
Pré-requisitos: integração com a API Cobranças e contas Efí para os participantes que receberão os repasses.
Ver exemplo de Split de Pagamento
Consultar documentação de Split de Pagamento
Da prova de conceito à integração
A escolha entre as APIs financeiras depende menos de encontrar uma funcionalidade isolada e mais de entender a jornada: quem paga, como paga, quando o dinheiro deve ser recebido e para quem ele precisa ser destinado.
Os exemplos oficiais do Efí Bank ajudam o time técnico a testar esses cenários antes de avançar para uma implementação própria. Eles devem ser adaptados às regras, à segurança e à arquitetura do ambiente de produção.
Para construir uma operação com Pix, cartão, boleto, recorrência, split e outros meios integrados ao seu sistema, confira as soluções de pagamentos do Efí Bank e avalie quais APIs fazem sentido para a arquitetura da sua empresa.
Explore as soluções de pagamentos do Efí Bank
Perguntas frequentes sobre APIs financeiras
Como escolher uma API financeira para integrar ao meu sistema?
A escolha depende da jornada de pagamento, dos meios que serão aceitos, da recorrência, do modelo de repasse e da experiência desejada para o cliente. O ideal é partir do problema que a integração precisa resolver.
Como funciona uma integração com API de pagamentos?
O sistema envia os dados da cobrança para a API, recebe as informações necessárias para o pagamento e acompanha o status da transação. O fluxo exato varia conforme Pix, cartão, boleto, recorrência ou split.
Quais são os principais requisitos para integrar uma API financeira?
Os requisitos variam conforme a API, mas podem incluir conta Efí Bank, aplicação habilitada, credenciais, escopos e, em algumas integrações, certificado digital. É importante conferir a documentação específica de cada recurso.
Compartilhe nas redes: