¶ Vindi
A integração com a plataforma Vindi permite que o HubSoft se comunique com o banco via API para realizar operações de cobrança bancária. Com ela, é possível:
- Emitir Boletos e Carnês
- Cancelar Boletos e Carnês
- Verificar Pagamentos
Para essa integração, precisaremos do seguinte parâmetro:
- chave_api: (Obrigatório) Chave da API Privada da Vindi (Disponível no painel Vindi em Configurações > Chaves de API). A chave é utilizada como usuário na autenticação HTTP Basic
¶ Configurando no HubSoft
Agora, com os dados em mãos, vamos até o HubSoft para cadastrar a Integração.
O primeiro passo é acessar o Menu lateral > Configuração > Integrações > Pagamento, conforme imagem abaixo.
Clique em Adicionar e inclua os dados da integração, sendo eles:
- chave_api: (Obrigatório) Chave da API Privada da Vindi (Disponível no painel Vindi em Configurações > Chaves de API). A chave é utilizada como usuário na autenticação HTTP Basic.
Temos também os parâmetros opcionais, que são:
- payment_method_code: (Opcional) Método de pagamento utilizado na emissão da fatura na Vindi. Valores aceitos (bank_slip|pix|credit_card|debit_card). Caso nada seja preenchido o sistema irá assumir o valor «credit_card», em que a Vindi tentará cobrar o cartão já cadastrado no perfil de pagamento do cliente. Atenção: o método informado precisa estar habilitado na conta da Vindi do provedor, caso contrário a plataforma recusará a emissão da fatura informando que o método de pagamento não foi encontrado
- ambiente: (Opcional) Indica se a integracão está em produção ou não. Valores aceitos (homologacao|producao). Caso nada seja preenchido o sistema irá assumir o valor «producao»
- transmite_baixa: (Opcional) Indica se a integração irá transmitir as baixas de títulos, por exemplo: recebimentos na empresa, descontos totais, ou seja, situações onde o título deverá ser baixado no gateway. Valores aceitos (true|false). O não preenchimento desse atributo, faz com que o sistema não transmita as baixas para a Vindi
- data_inicio_consulta_pagamento: (Opcional - Usar com Cautela) Data Inicial que o sistema utilizará para consultar os boletos que foram pagos. O campo deve ser cadastrado no formato DD/MM/YYYY (EX: 01/01/2024). Esse parâmetro somente deverá ser utilizado para realizar algum ajuste de dias que o sistema tenha ficado sem consultar a integração (EX: Sistema Inoperante, etc). Caso contrário, esse parâmetro não deverá ser adicionado na integração. Após o sistema realizar o devido ajuste nos pagamentos, esse campo também deverá ser removido dos parâmetros da integração para que o sistema volte a liquidar os pagamentos do dia atual.
- data_fim_consulta_pagamento: (Opcional - Usar com Cautela) Data Final que o sistema utilizará para consultar os boletos que foram pagos. O campo deve ser cadastrado no formato DD/MM/YYYY (EX: 01/01/2024). Esse parâmetro somente deverá ser utilizado para realizar algum ajuste de dias que o sistema tenha ficado sem consultar a integração (EX: Sistema Inoperante, etc). Caso contrário, esse parâmetro não deverá ser adicionado na integração. Após o sistema realizar o devido ajuste nos pagamentos, esse campo também deverá ser removido dos parâmetros da integração para que o sistema volte a liquidar os pagamentos do dia atual.
Após preencher, clique em Salvar e a integração será cadastrada. Para validar se as credenciais estão corretas, basta realizar o teste da integração, em Ações > Testar Integração.
Feito isso, devemos configurar a Forma de Cobrança. É necessário associar a integração à forma de cobrança, para que os boletos sejam registrados e compensados.
Vá ao Menu lateral e acesse Configuração > Financeiro > Forma de Cobrança e clique em Adicionar.
Preencha o banco como Vindi e selecione a Integração criada. Na próxima aba Configuração, preencha os dados obrigatórios (*) e por fim, clique em Salvar.
Ao finalizar, já estará configurado para emitir seus boletos no Hubsoft integrado ao Vindi.
¶ Perguntas/Problemas Frequentes
Abaixo serão listadas algumas perguntas/problemas frequentes relacionados ao Vindi. Caso alguma dessas situações aconteça e você tenha dificuldades para resolver, não hesite em chamar nosso suporte, pois estamos aqui para lhe ajudar.
¶ A integração com o Vindi, transmite baixas automaticamente?
Sim, caso a forma de cobrança permita baixas e na integração tenha o parâmetro transmite_baixa com valor true indica que a integração irá transmitir as baixas de títulos, por exemplo: recebimentos na empresa, descontos totais, ou seja, situações onde o título deverá ser baixado no gateway. Valores aceitos (true|false). O não preenchimento desse atributo, faz com que o sistema não transmita as baixas para o Vindi
¶ E é possível transmitir baixas como cancelamentos?
É sim, temos também o parâmetro transmite_baixa_sendo_cancelamento que indica se a integração deve transmitir as baixas de títulos como cancelamentos na plataforma.
Para ativar essa opção, o parâmetro transmite_baixa deve ser configurado como true. Usos típicos incluem casos como recebimentos na empresa ou concessão de descontos totais, em que o título deve ser baixado no gateway. Os valores aceitos são true ou false. Se este atributo não for preenchido, o sistema transmitirá as baixas como pagas, e não como cancelamentos, para o Vindi.