# Efí - Pix Avulso

## Introdução
A integração entre o Sistema e a plataforma de pagamentos Efí Bank visa simplificar fluxos financeiros e de vendas, oferecendo soluções de pagamento robustas e eficientes. Esta documentação detalha o processo de integração, seus benefícios e configurações necessárias.

> [!TIP] Solução Oferecida
> Meio para pagamentos de cobranças via Pix com liquidação imediata.

> [!NOTA] Acesso ao Formulário
> **Caminho**: Sistema > Cadastros > Financeiro > Carteira de cobrança

### Benefícios da Integração

| Benefício                  | Descrição                                                                                   |
| -------------------------- | ------------------------------------------------------------------------------------------- |
| Automação                  | Redução de intervenção manual e aumento da eficiência operacional                           |
| Flexibilidade de Pagamento | Oferece o Pix como forma alternativa de pagamento a cobrança original do cliente            |
| Conveniência para Clientes | Pagamentos de liquidação imediata liberam a conexão do cliente bloqueado com mais agilidade |

> [!TIP] Melhoria!  
> Agora, a Carteira de Pix Avulso da **Efí** possui a opção de **bloquear a Chave Pix** para transferências manuais.  
> Essa melhoria impede que os clientes realizem transferências diretas entre contas utilizando a Chave Pix como código de pagamento. Com isso, os pagamentos poderão ser feitos apenas por meio do código Pix exclusivo da fatura (**TxID**).  <hr>
> Para ativar esse bloqueio, acesse a configuração da sua Carteira de Pix Avulso da **Efí**, vá até a aba **Configurações Pix** e clique no botão **Desabilitar pagamento com chave Pix**.

## Como Funciona a Integração  

1. **Configuração**  
2. **Acesso à Central do Assinante**  
3. **Escolha da Opção de Pagamento**  
4. **Geração do Pix**  
5. **Pagamento**  
6. **Liquidação no Sistema**  

### Abas de Configuração do Módulo:  
* **Carteira de Cobrança**  
* **Configurações Pix**  
* **Juros/Multas/Desconto**  
* **Instruções**  

## Campos Obrigatórios  

* **Descrição**: Nome do cadastro da carteira de cobrança.  
* **Conta**: Cadastro da conta vinculada à carteira.  
* **Tipo de recebimento**: Modalidade da integração que gera as cobranças.  
* **Validar filial na venda**: Se marcado como **Sim**, exige que a filial do Contrato do Cliente seja a mesma da carteira de cobrança.  
* **Ativo**: Ativa ou inativa o cadastro da carteira de cobrança no Sistema.  

## Processo de Integração e Homologação  

Para realizar a integração e homologação da **Integração de Pix Efí Bank** no Sistema, siga estes passos:  

### Homologação  

Para iniciar a integração, é necessário abrir um atendimento com o setor **Suporte Técnico** e ter em mãos os seguintes dados:

> [!EXAMPLE] Dados Necessários
>
> **364 - Efí Bank (API Pix)**
>
> * 1 - Número da agência com dígito?
> * 2 - Número da conta com dígito?
> * 3 - Pix chave?
> * 4 - Pix Client ID?
> * 5 - Pix Cliente Secret?
> * 6 - Pix Certificado?

> [!TIP] Dica!  
> Se tiver dúvidas sobre algum dos dados bancários, consulte o gerente da sua conta bancária.

### Passo a Passo para Obter as Credenciais da API  

1. Acesse o **[Internet Banking Efí Bank](https://login.sejaefi.com.br/oauth/authorize?redirect_to=https://app.sejaefi.com.br/)**.  
2. Faça login com sua conta.  
3. No menu lateral esquerdo, clique em **API**.  
4. Na tela de Introdução, clique em **Criar aplicação**.  
5. Insira um nome para sua aplicação, como **Efí Pix - IXC**, e clique em **Continuar**.  
6. No menu **Escopos**, na seção **API Cobranças**, marque a opção **Emissão de cobranças**.  
7. Na seção **API Pix**, marque todas as opções das colunas **Produção** e **Homologação**, exceto o parâmetro **Consultar Saldo**.  
8. Clique no botão **Continuar**.  
9. Insira a **Assinatura eletrônica** da sua conta Efí.  
10. De volta ao menu Introdução, clique em **Minhas Aplicações**.  
11. Encontre a aplicação criada, clique no botão **Ações** localizado à direita e selecione **Detalhar**.  
12. Copie as credenciais da API:  
    - **Chave Client ID**  
    - **Chave Client Secret**

> [!Info] Informação!
> Acesse [[criar certificado digital api pix efi bank|Criar Certificado Digital API Pix Efí Bank]] para saber como obter seu Certificado Digital da API Pix Efí, necessário para a configuração de sua carteira.

> [!SUCCESS] Credenciais API Finalizadas!
> Feito isso, com as Credenciais da API Pix e o Certificado Pix em mãos, o Suporte da IXC Soft prosseguirá com a homologação da sua Carteira de Cobrança Pix.

### Criando a Carteira  

1. Acesse o menu **Sistema**.  
2. Entre na pasta **Financeiro**.  
3. Clique em **Carteira de cobrança**.  
4. Clique em **Novo**.  
5. Na aba **Carteira de cobrança**, configure os seguintes campos:  
   - **Descrição:** Defina o nome da carteira.  
   - **Conta:** Crie a conta responsável por armazenar os dados bancários.  
   - **Tipo de recebimento:** Selecione a opção **Pix**.  
   - **Enviar e-mail para cliente ao gerar:** Marque **Não**, pois torna obrigatório o e-mail do cliente e envia automaticamente a fatura, registrando-a no banco (não recomendado).  
   - **Validar filial na venda:** Marque **Não**.  
   - **Ativo:** Mantenha **Sim**.  
   - **Filial:** Remova o cadastro clicando no botão **X** posicionado ao lado direito do campo.  
   - **Planejamento analítico:** Utilize o padrão **240** ou cadastre um novo.  

### Criando a Conta  

- **Conta:** Defina um nome para a conta.  
- **Tipo da Conta:** Marque **Banco**.  
- **Data de abertura:** Informe a data de configuração da conta para esta carteira.  
- **Planejamento analítico:** Para mais informações, acesse: [[formulario planejamento analitico|Formulário Planejamento Analítico]].  
- **Filial:** Selecione o ID da filial para a qual serão criadas a **Conta** e a **Carteira**.  

Na aba **Banco**:  
- **Banco:** Selecione o ID da instituição conforme o cadastro nacional de bancos. Neste caso, escolha:  
  - **364 - Efí Bank**  
- **Agência:** Número da sua agência bancária.  
- **Dígito verificador da agência:** Insira o dígito verificador que fica após o número da agência.  
- **Número da conta:** Informe o número da conta bancária.  
- **Dígito verificador da conta:** Informe o dígito verificador da conta bancária.  

### Configurações Pix  

- **Pix gateway:** Selecione **Efí**.  
- **Pix ambiente:** Escolha **Produção**.  
- **Pix chave:** Insira uma chave Pix cadastrada em sua conta Efí Bank, de preferência uma **chave do tipo aleatória**.  
- **Pix Client ID:** Insira a credencial gerada na conta Efí Bank.  
- **Pix Client Secret:** Insira a credencial gerada na conta Efí Bank.  
- **Pix tempo de validade:** Defina o padrão **3600** (1 hora).  
- **Pix Certificado:** Insira o arquivo do certificado digital.  
- **Pix URL callback:** Primeiro, clique em **Salvar** para gravar as alterações da carteira. Em seguida, clique no botão **Gerar URL Pix** para criar a URL Callback, que permitirá a comunicação das notificações (logs de pagamento) da Efí Bank com a sua base no Sistema.  

### Juros/Multas/Desconto  

- **Juros %:** Configure **0.033%** (máximo permitido por lei, acima deste valor caracteriza juro abusivo).  
- **Multa %:** Configure **2%** (máximo permitido por lei, acima deste valor caracteriza multa abusiva).  
- **Desconto até o vencimento R$:** Insira um valor em **Reais** para conceder desconto na fatura, se o pagamento for feito até a data do vencimento.  
- **Desconto até o vencimento %:** Insira um valor em **Porcentagem** para conceder desconto na fatura, se o pagamento for feito até a data do vencimento.

Para mais informações, acesse: [[juros, multas e desconto|Juros, Multas e Desconto]].
> [!WARNING] Aviso!  
> A integração de Pix Efí Bank não possui valor mínimo para o registro de uma cobrança.  

> [!NOTE] Dica!  
> Para concluir a configuração da sua carteira, clique no botão **Salvar**. <hr>
> Agora, é essencial ativar a carteira no sistema para que seus clientes possam utilizar essa modalidade de pagamento, seguindo as instruções abaixo.  

## Ativando a Carteira de Cobrança no Sistema  

Após configurar sua carteira, é necessário vinculá-la de uma das seguintes formas:  

* **Hotsite (Central do Assinante):** Configurando a carteira nos parâmetros gerais do sistema no Hotsite, todos os clientes da base poderão utilizá-la para efetuar pagamentos através da **Central do Assinante**.  
* **Alternativa de Pagamento:** Vinculando a carteira a uma **Alternativa de Pagamento**, é possível incluí-la dentro de carteiras de cobrança específicas. Isso permite, por exemplo, restringir o pagamento via Pix a um grupo específico de clientes ou criar diferentes opções de pagamento com carteiras que possuem condições distintas, como descontos até o vencimento.  

### Configurando a Carteira no Hotsite - Central do Assinante  

1. Acesse o menu **Sistema**.  
2. Entre no submenu **Hotsite**.  
3. Vá até a pasta **Configurações**.  
4. Clique em **Configuração Geral**.  
5. Acesse a aba **Financeiro**.  
6. Na seção **Pix**, configure os seguintes parâmetros:  
   - **Habilitar Pix:** Marque esta opção para ativar o pagamento via Pix na sua Central do Assinante.  
   - **Carteira de cobrança (Pix):** Vincule a carteira Pix criada, tornando-a a carteira Pix padrão do sistema.  
7. Clique em **Salvar** para finalizar.  

### Configurando a Carteira como Alternativa de Pagamento  

1. Cadastre uma **Alternativa de Pagamento**, conforme as instruções em [[configuracoes alternativas de pagamento|Configurações Alternativas de Pagamento]].  
2. No menu **Sistema > Cadastros > Financeiro > Carteira de Cobrança**, localize a carteira na qual deseja implementar a alternativa.  
3. Clique em **Editar**.  
4. No campo **Configuração de alternativa de pagamento**, insira o **ID** ou utilize a **Lupa** para localizar o cadastro da Alternativa criada.  
5. Clique em **Salvar** para concluir a configuração.  

> [!SUCCESS] Concluído!  
> Somente clientes cuja carteira padrão do contrato contenha a **Alternativa de Pagamento** vinculada ao Pix poderão efetuar pagamentos por meio dessa opção.

## Fluxos e Processos

### Fluxo de Integração
```mermaid
sequenceDiagram
    participant S as Sistema
    participant API as API Efí Bank
    participant W as Webhook

    S->>API: Envia requisição (ex: gerar fatura)
    API->>S: Responde com dados da fatura
    Note over API,W: Evento ocorre (ex: pagamento)
    W->>S: Notifica sobre o evento
    S->>API: Confirma recebimento da notificação
```

## Considerações Finais  

A integração com a **Efí Bank** representa um avanço importante para melhorar a gestão financeira dos provedores de serviço. Com automação, redução de custos e suporte às necessidades dos clientes, essa parceria contribui para um gerenciamento financeiro mais eficiente e simplificado.

## Etiquetas 
#IntegracaoFinanceira #EfiBank #PagamentosOnline #APIPix #QRcodePix

## Leia Também
- [[carteira de cobranca|Carteira de Cobrança]]
- [[financeiro|Financeiro]]
- [[integracoes bancarias - carteira de cobranca|Integrações Bancárias - Carteira de Cobrança]]
- [[integracoes bancarias - pix avulso|Integrações Bancárias - Pix Avulso]]
- [[erros comuns na comunicacao de cobrancas efi bank|Erros Comuns na Comunicação de Cobranças Efí Bank]]
- [[rotina consulta recebimento cobrancas api pix|Rotina Consulta Recebimento Cobranças API Pix]]
- [[criar certificado digital api pix efi bank|Criar Certificado Digital API Pix Efí Bank]]
- [[tarefa - garantia de baixa de pagamentos|Tarefa - Garantia de Baixa de Pagamentos]]
- **Manual API Pix Efí Bank**: https://dev.efipay.com.br/docs/api-pix/credenciais/