Introdução
A integração entre o Sistema e a plataforma de pagamentos modobank visa simplificar os fluxos financeiros e de vendas, proporcionando soluções de pagamento seguras e eficientes. Esta documentação apresenta detalhes sobre o processo de integração, seus benefícios e as configurações necessárias.
Solução Oferecida
Meio para pagamentos de cobranças via Pix e emissão de cobranças Pix com liquidação imediata.
Acesso ao Formulário
Caminho: Sistema > Cadastros > Financeiro > Carteira de cobrança
Benefícios da Integração
| Benefício | Descrição |
|---|---|
| Cobrança Pix | Possibilita a emissão direta da cobrança Pix, sem a necessidade de outra cobrança bancária |
| Automação | Redução de intervenção manual e aumento da eficiência operacional |
| Flexibilidade de Pagamento | Também 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 |
| Estorno do Pix | Caso o Banco Central estorne um pagamento Pix, o status da cobrança é revertido no Sistema, tornando o cliente novamente inadimplente |
Nova Função!
Estorno do Pix
- Agora, caso o Banco Central estorne um pagamento de cobrança Pix via contestação do cliente por meio de seu aplicativo bancário, o estorno ocorrerá no Sistema também, ou seja, o status da cobrança será revertido para A Receber. Esta medida visa tratar devidamente as ocorrências de estorno, mas principalmente, impedir a ação de clientes com má-fé.
Observação: após o estorno, seu contas a receber ficará disponível para a solicitação de uma nova cobrança.
Estrutura
Como Funciona a Integração
- Configuração
- Acesso à Central do Assinante
- Escolha da Opção de Pagamento
- Geração do Pix
- Pagamento
- 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 modobank no Sistema, siga estes passos:
Homologação
Para iniciar a integração, é necessário abrir um atendimento com o setor responsável e ter em mãos os seguintes dados:
Dados Necessários
modobank (API Pix)
- Número da agência com dígito.
- Número da conta com dígito.
- Pix chave.
- Pix Client ID.
- Pix Client Secret.
- Pix Certificado.
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
- Acesse o Internet Finance modobank.
- Faça login com sua conta.
- Navegue até o menu Configurações e clique em Gerar credenciais.
- Copie as credenciais da API:
- Chave Client ID
- Chave Client Secret
Atenção!
Não é recomendado gerar as credenciais mais de uma vez. Caso sejam geradas novamente, será necessário atualizá-las na carteira de cobrança no Sistema e gerar uma nova URL Callback.
Credenciais API Finalizadas!
Com as credenciais em mãos, o suporte da IXC Soft prosseguirá com a homologação da sua Carteira de Cobrança Pix.
Criando a Carteira
- Acesse o menu Sistema.
- Entre na pasta Financeiro.
- Clique em Carteira de Cobrança.
- Clique em Novo.
- 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 para o banco (não recomendado).
- Validar filial na venda: Marque Não.
- Ativo: Mantenha Sim.
- Filial: Remova o cadastro clicando no botão X 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: 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:
- Agência: Número da sua agência bancária.
- Dígito verificador da agência: Insira o dígito verificador 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.
Configurações Pix
- Pix gateway: Selecione modobank.
- Pix ambiente: Escolha Produção.
- Pix chave: Insira uma chave Pix cadastrada em sua conta modobank, de preferência uma chave do tipo aleatória.
- Pix Client ID: Insira a credencial gerada na conta modobank.
- Pix Client Secret: Insira a credencial gerada na conta modobank.
- 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 modobank 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.
Importante!
Para concluir a configuração da carteira, clique no botão Salvar.
Agora, é essencial ativá-la 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
Você pode vincular sua carteira de duas formas:
Configurando a Carteira no Hotsite - Central do Assinante
- Acesse o menu Sistema.
- Entre no submenu Hotsite.
- Vá até a pasta Configurações.
- Clique em Configuração Geral.
- Acesse a aba Financeiro.
- 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.
- Clique em Salvar para finalizar.
Configurando a Carteira como Alternativa de Pagamento
- Crie uma Alternativa de Pagamento, conforme as instruções em Configurações Alternativas de Pagamento.
- No menu Sistema > Cadastros > Financeiro > Carteira de Cobrança, localize a carteira desejada.
- Clique em Editar.
- No campo Configuração de alternativa de pagamento, insira o ID ou utilize a Lupa para localizar o cadastro da Alternativa criada.
- Clique em Salvar para concluir.
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
sequenceDiagram participant S as Sistema participant API as API modobank 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 modobank representa um importante avanço para aprimorar 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 modobank PagamentosOnline APIPix QRcodePix