Configurando conector iugu na VTEX
O conector da iugu é um facilitador de integração entre Vtex e iugu, com a finalidade de auxiliar na cobrança de vendas e permitimos ao Marketplace a opção de Split de Pagamento.
Pré-requisitos
- Plataforma Vtex, contratada e com url publicada
- Contrato com a iugu
- Métodos de pagamento habilitado na plataforma da iugu ( PIX, Boleto Bancário e Cartão de Crédito). Verifique no Painel iugu >> Configurações >> Recebimento.
- Id da conta iugu e chave api de produção.
Funcionalidades disponíveis
- Vendas avulsas
- Split de pagamentos para marketplace (MVP)
- Recorrência pela Vtex (MVP)
O conector construído para a iugu segue a arquitetura PPP.
Localizando ID da conta e chave API no painel da iugu
ID da conta
Para localizar o id de sua conta iugu, siga os passos baixo:
- Acesse seu painel da iugu;
- Clique em configurações;
- Em seguida, clique em informações da conta e dados conta;
- Copie o ID que está abaixo de "ID da conta".
Tokens API!
- Trate seus tokens API como senhas. Não inclua seu token API publicamente em nenhum lugar do seu site(client-side) lembre-se que esta chave dá acesso total aos seus dados na iugu. Então ela deve ser utilizada apenas via server-side.
- Recomendamos que você atualize sua chave de API a cada 30 dias - é importante que você mantenha sua chave atualizada evitando que ela seja usada no caso de vazamento de suas informações.
Habilitando conector iugu
Ao acessar a plataforma é necessário acessar o menu Configurações da loja >> Pagamentos >> Provedores :
Em seguida você deve acessar a opção Novo Provedor, pesquisar iugu e clicar sobre:
Atenção!!
Antes de confirmar o conector iugu se atente a nomenclatura, poderá haver nomes semelhantes. Como por exemplo "iuguu", sendo a nomenclatura correta é iugu.
A próxima tela, será de configuração do conector. É necessário preencher as seguintes informações abaixo:
- Chave de Aplicação (id da conta iugu)
- Token de Aplicação (chave API)
- Nome - iugu
- Caso seja interessante no seu modelo de negócio é possível habilitar o modo teste;
- Se for atuar no modelo marketplace com comissionamento, deverá ativar o split de recebíveis.
- Prazo de vencimento do boleto(em dias)
Em seguida, preencha os campos da tela de configuração:
Como localizar o ID da conta e o token API?
Veja nossa FAQ "ID da conta e tokens de API teste e produção"
Configurando condições de pagamento.
Para isso clique em Configurações da Loja >> Pagamentos >> Configurações ⇾ adicionar.
Configurando método de pagamento PIX:
Para habilitar, acesse o Painel Alia Configurações, vá até a opção PIX no menu do lado esquerdo da tela para ativar como método de pagamento: marcar como Ativo e clique em Salvar.
Para habilitar na VTEX clique em condições de pagamento > adicionar.
Escolha o método de pagamento PIX e clique nele para configurar.
Selecione a afiliação iugu criada anteriormente, atualize o status da condição de pagamento, adicione condições especiais caso necessário e clique em salvar.
Configurando método de pagamento Cartão de Crédito
Para habilitar, acesse o Painel Alia Configurações, vá até a opção Cartão de Crédito no menu do lado esquerdo da tela para ativar como método de pagamento: marcar como Ativo, configure Descrição na Fatura, Parcelas e clique em Salvar.
Fluxo de Pagamento em Duas Etapas
Caso esteja habilitado, as transações serão autorizadas e canceladas após 7 dias pois o conector VTEX não está preparado para capturar a transação. Em desenvolvimento para Q3/2024
Para configurar o método de cartão de crédito na VTEX, ir até a opção Condições de Pagamentos, ir em adicionar e escolha qual bandeira de cartão a ser configurada.
Atenção!!
Para o método de pagamento cartão de crédito, será preciso configurar em cada bandeira, conforme exemplo abaixo:
Após escolher, habilitar o status para ativa, selecionar iugu em processar com a afiliação e definir o modelo de cobrança à vista ou parcelado e salvar.
Caso opte por receber parcelado, é possível realizar repasse de juros do pagador.
Configurando método de pagamento boleto
Para habilitar, acesse o Painel Alia > configurações, vá até a opção Boleto no menu do lado esquerdo da tela para ativar como método de pagamento: marcar como Ativo, configure os prazos e clique em Salvar.
Após ativar no Painel Alia, acessar as configurações na VTEX.
Ative o boleto e processar com a afiliação iugu
Marketplace com Split de pagamento
Pré-requisitos
- Habilitado modo marketplace na Vtex.
- Plano iugu Marketplace
Configurando Marketplace com Split de Pagamento
É obrigatório que cada seller esteja cadastrado utilizando o mesmo CNPJ na VTEX e no Painel iugu.
Atenção!!
- Não recomendado ter mais de uma subconta na iugu e mais de um seller na Vtex com o mesmo CNPJ, caso tenha haverá conflito no momento do split.
- Caso tenha configurado o Split no Painel iugu ele não refletirá na VTEX.
- A configuração do Split demora 2-3 dias para ser efetivada no painel da VTEX, é possível validar através da documentação da VTEX a configuração atual.
As configurações de Split, serão realizadas nas configurações de cada seller dentro de seu painel administrador Vtex. Para auxiliar nesse processo deixamos abaixo um exemplo de configuração e a Vtex disponibiliza a documentação sobre configuração dos sellers.
A liquidação do Split ocorrerá conforme seu método de pagamento e acordo comercial com a iugu. Cada método de pagamento tem um tempo de compensação diferente.
Criação de subconta(sellers) na iugu:
Há duas formas de se criar subcontas na iugu, essas formas são:
Observação:Caso crie a subconta via API é necessário disparar a requisição enviar a verificação da subconta (Doc API).
Habilitando Split de Pagamento iugu na Vtex.
- Acesse a opção “Afiliações de Gateway” clicando em: Configurações da loja >> Pagamentos >> Provedores.
- Em seguida clique em “+”, para adicionar uma nova afiliação de gateway ou selecione caso já tenha uma cadastrada.
- Configure as informações:
- Application Key (id da conta iugu)
- Application Token (chave API)
- Prazo de vencimento do boleto (deverá ser o mesmo configurado no painel da iugu, caso utilize esse método de pagamento)
- Ativar divisão e enviar recebedores? Esta opção habilita o Split de pagamentos, após selecionar a opção “sim”, aparecerá mais duas opções:
Responsabilidade pelas tarifas de pagamento e Responsabilidade pelos estornos.
Atenção:
Não está disponível ambiente de teste, caso utilize chave de ambiente de teste isso não será aplicado a sua conta e retornará erro. Quando estiver disponível iremos comunicar.
- Após configurado, salve e aguarde cerca de 10 minutos para a funcionalidade de split ser ativada nos métodos de pagamentos.
Exemplo de configuração do Comissionamento em cada seller vinculado na VTEX:
Informação importante!
As imagens atreladas a essa documentação servem apenas como exemplo e sua visualização dentro da plataforma VTEX poderá ser diferente, nesse caso orientamos a consultar a documentação da VTEX sobre Split de Pagamento.
Dentro da plataforma VTEX acesse Marketplace >> Gerenciamento:
Acesse o seller que realizará a configuração do Split.
Nessa tela será possível realizar o comissionamento por percentual sobre produto ou frete, e caso necessário adicionar comissões por categoria.
Recorrência na Vtex
Pré-requisitos
- Habilitado modo Recorrência na VTEX
- Métodos de pagamento habilitado na plataforma da iugu ( Boleto Bancário e Cartão de Crédito). Verifique no Painel iugu >> Configurações >> Recebimento.
- Conector iugu habilitado na Vtex (configurado comId da conta iugu e Chave api de produção.
- Condições de pagamentos habilitado na Recorrência Boleto e Cartão de Crédito.
Particularidades.
Após habilitado o modo de recorrência, é necessário criar planos que será o motor de recorrência das assinaturas e criação de faturas.
Para configurar acesse a documentação da Vtex: Como configurar Assinaturas na sua loja
Informação importante!
A Vtex é responsável pelo motor de recorrência e criará cada ciclo da assinatura, sendo assim, na no painel da iugu será apresentado como fatura avulsa.
Exemplos de Criação de Planos na VTEX
Acesse Pedidos >> Assinaturas >> Planos >> Novo Plano:
Configure nome e periodicidade de cada plano:
Adicione o vincule o produto ao plano:
Atenção!!
- O produto Split de Pagamento e Recorrência estão em MVP, caso tenha interesse entre contato conosco.
Reportar erro
Caso ocorra alguma eventualidade em relação ao pagamento, em todos os casos é necessário nos encaminhar os eventos da transação. Para isso você deve acessar sua conta Vtex e seguir o caminho abaixo:
Pedidos > Transações:
Buscar/Selecionar transação:
Eventos da transação:
Obs.: É necessário nos encaminhar todo o evento da transação em um arquivo ".txt" através do nosso suporte.
Atenção!!
A Vtex possui um tempo de até 10 minutos para que a configuração ou ajuste esteja disponível.
Updated about 2 months ago