Árvore de páginas

Esse documento contém informações e descreve operações que podem auxiliar no processo de parametrização do plugin Pagamento Recorrente.

Conteúdo

  1. Configurar dados de operadora.
  2. Configurar dados de e-mail para o cliente cadastrar cartão de crédito.
  3. Configurar dados de e-mail para o cliente efetuar pagamento de boleto bancário.

Acesso ao plug-in

Plug-in → Pagamento Recorrente → Parâmetros

Interface

A tela a seguir permite criar e editar os parâmetros que estarão relacionados a empresa logada, portanto, cada empresa requer os parâmetros apropriados para o processo de integração.


ControleDescrição
Alteração de parcelaRequer a informação para o processo de alteração do tipo de parcela para tratamento no contas a receber.
Tipo de ambienteRequer atenção nesta informação, pois, deve estar relacionado a URL de acesso as APIs.

1 - Configurar dados de operadora

A operadora é a empresa responsável pelo processamento de pagamentos recorrentes. Os parâmetros da operadora estará abrangendo um tipo de pagamento, podendo ser: cartão de crédito, boleto bancário ou pix. Necessário a associação da operadora ao tipo de débito/crédito dos lançamentos a serem integrados na operadora.  

ControleDescrição
OperadoraSelecione o tipo de operadora. Em seguida, que os parâmetros da operadora serão apresentados.
Nome da operadoraInforme uma descrição.  Como sugestão, pode-se incluir o tipo de pagamento.
Integrar com dias de antecedência

Se informado, o serviço integrará as parcelas, de acordo com número de dias para antecipar em relação a data de vencimento.

Parâmetro disponível para qualquer operadora, portanto, o usuário deve avaliar se a operadora aceita esse tipo de integração.

Enviar link boleto com dias de antecedência

Se informado, o serviço enviará para o cliente o link para pagamento da parcela que foi gerado pela operadora, de acordo com número de dias de antecipação em relação da data de vencimento,.

Parâmetro disponível para operadora do tipo de pagamento boleto, e que, não tenha o envio automático do boleto para o cliente.

(informação)  Configurar para operadora Netcred boleto, o envio do link será somente das parcelas com status de agendada ou faturado.

Parâmetros da operadora Vindi

ControleDescrição
URLEndereço de acesso as APIs conforme o tipo de ambiente selecionado.
TokenChave de acesso ao ambiente de integração.
Id ProdutoIdentificador do produto de pagamento recorrente fornecido pela operadora, de acordo com o tipo de ambiente. 
Método pagamento

Executa a carga dos códigos de método de pagamento via API para compor o cadastro de método de pagamento e somente para operadora do tipo de pagamento boleto. 

(informação)
As operações de incluir, alterar e excluir não estão disponíveis no cadastro de método de pagamento. 
Botão disponível somente para operadora Vindi boleto.

Parâmetros da operadora Netcred


ControleDescrição
URLInforme o endereço de acesso as APIs conforme o tipo de ambiente selecionado.
UsuárioNome do usuário para autenticação de acesso ao ambiente de integração.
SenhaSenha do usuário para autenticação de acesso ao ambiente de integração.
Código da companhiaCódigo fornecido pela operadora.
Faturar com dias de antecedência

Quantidade de dias de antecedência que a operadora irá gerar o boleto, ou seja, se colocar 5, o boleto será gerado pela operadora 5 dias antes do vencimento.

(informação)  Utilizar essa configuração apenas para boleto, pois cartão deve ser integrado pelo operadora no dia de vencimento.

Carteiras

Executa a carga das carteiras via API para compor o cadastro de carteira. Um registro de carteira representa as parcelas selecionadas para o processo de integração.

(informação)  A operação de incluir não está disponível no cadastro de carteiras.

Selecionar carteira no momento da integração

Se informado, o processo de integrar parcelas abrirá uma tela para selecionar a carteira para pagamento.

Se não informado, o processo de integrar parcelas associará uma carteira cadastrada como avulsa.

2 - Configurar dados de e-mail para o cliente cadastrar cartão de crédito

A tela a seguir apresenta uma configuração padrão do sistema, que poderá ser editada conforme o critério do usuário. O texto deverá reportar ao cliente a necessidade de cadastrar um cartão de crédito para o devido pagamento da parcela. O cartão cadastrado será associado a parcela na tela de movimentação para integração com a operadora.

3 - Configurar dados de e-mail para o cliente efetuar pagamento de boleto bancário

A tela a seguir apresenta uma configuração padrão do sistema, que poderá ser editada conforme o critério do usuário. O texto deverá reportar ao cliente que foi gerada a cobrança conforme dados da parcela para pagamento.


ControleDescrição
Botão restaurarSe clicado, restaura o texto padrão do sistema.
Tag

Informação obrigatória conforme apresentado no texto padrão, mesmo que o texto tenha sido editado.

<CLIENTE>Nome do cliente
<DADOSCONTRATO>Nome do contrato e número do contrato
<LINK>

No envio de e-mail de cartão de crédito, será aberto a tela para cadastro do cartão de crédito.

No envio de e-mail de boleto, será realizado o download do boleto.



Parâmetros

O botão de incluir estará disponível se não houver parâmetros cadastrados para a empresa logada.