VTEX Sellers - Marketplace

APP adicional para administração dos vendedores do Marketplace VETEX

Documentação legada do Pagar.me v5

Esta página descreve um conceito da Pagar.me v5 (versão clássica). Para projetos novos, explore o API Catalog.

APP adicional para administração dos vendedores do Marketplace VETEX

Introdução

Para os clientes que utilizam o Conector VTEX V3 e são Marketplaces, contamos com um APP extra, o VTEX Sellers.

Este aplicativo deve ser utilizado para administração de seus vendedores, fazendo a comunicação de forma prática entre a base da VTEX e do Pagar.me para processamento de Split de Pagamentos.

Requisitos

Conta Pagar.me com modelo de negócio PSP
Conector PagarMeV3 na sua loja VTEX

Vendedores

O Marketplace é composto por diversos vendedores que se cadastram no site e são comissionados pelas vendas. Essa é a forma como ele é visto por cada player:

Entidade	VTEX	Pagar.me
Vendedor	Seller	Recebedor
ID do vendedor	Customizável conforme critérios	Padrão: re_xxxxxxxxxxxx ou rp_xxxxxxxxxxxxx

Na prática, todo Seller VTEX deve ser vinculado a um Recebedor Pagar.me equivalente para transacionar.

Funcionalidades

Listagem completa de vendedores: detalhamento de informações do Seller VTEX, Recebedor Pagar.me equivalente e status para transacionar
Vínculo automático: crie um novo recebedor Pagar.me para um Seller já existente da VTEX
Vínculo manual: apenas vincule manualmente um recebedor já existente no Pagar.me a um Seller também já existente na VTEX
Desvínculo: caso necessário, você consegue desfazer a relação já existente entre um Sellex VTEX com um Recebedor Pagar.me, dessa forma, posteriormente esse Seller poderá ser vinculado a outro Recebedor Pagar.me

Instalando o VTEX Sellers

Para facilitar o processo esteja logado em sua Dashboard do Pagar.me e na sua loja VTEX. Vamos ao passo a passo:

Em sua loja VTEX, na url do site, acrescente a informação: apps/pagarme.pagarme-sellers@1.1.0/setup
Exemplo: https://[SUALOJA].myvtex.com/admin/apps/pagarme.pagarme-sellers@1.1.0/setup\
Após ser encaminhado ao APP na loja VTEX, clique em Instalar\
Recarregue a página clicando em F5

Pronto, o APP foi instalado com sucesso! Vamos seguir a próxima etapa.

Integrando o VTEX Sellers ao Pagar.me

Agora que o APP está instalado em sua loja, precisamos conectá-lo ao Pagar.me, vamos lá:

No menu lateral esquerdo clique em Aplicativos > Pagarme Sellers\
Após clique no botão Integrar com Pagar.me\
Você será direcionado ao HUB Pagar.me onde deve indicar a loja que deseja utilizar:

Após selecionada a loja, finalize clicando em Instalar APP

Feito! Agora os vendedores serão listados e poderão ser gerenciados diretamente em seu site.

Gestão de vendedores

Você já deve ter acesso à listagem completa de vendedores, conforme abaixo:

Essa tabela irá indicar sempre o Seller VTEX e seu Recebedor Pagar.me equivalente, caso não exista vínculo do Seller com o Recebedor, o campo fica em branco ("--------").

Ações

Vincular

Existem duas possibilidades para vínculo de um Seller VTEX a um Recebedor Pagar.me, eles se revelam ao clicar no botão Vincular da listagem:

Vínculo automático: Criar novo recebedor Pagar.me

Neste fluxo, você será encaminhado a uma página de formulário onde deve preencher todos os dados do vendedor (conforme etapas à direita).

Após a conclusão, o Seller VTEX será vinculado automaticamente a um novo Recebedor Pagar.me que será criado ao clicar no botão Salvar.

Em seguida, você será encaminhado a listagem, onde o vínculo estará estabelecido!

Adequações Bacen

Todo o formulário que coleta as informações para criação de recebedores já está adaptado segundo as diretrizes regulatórias do Bacen para Markeplaces, mais informações aqui.

Vínculo manual: Vincular a um recebedor Pagarme já existente

Este segundo fluxo será utilizado caso já exista um Recebedor Pagar.me criado anteriormente com os dados do Seller VTEX e você só precise estabelecer o vínculo entre eles.

Preencha o ID do Recebedor Pagar.me desejado e clique em Avançar:

Confira os dados e finalize clicando em Continuar:

Em seguida, você será encaminhado para uma página de sucesso e então à listagem, onde o vínculo estará estabelecido!

Desvincular

Caso possua um Seller VTEX vinculado a um Recebedor Pagar.me, mas por algum motivo precisar desfazer essa relação, basta seguir da seguinte forma:

Localize o vendedor que deseja realizar o desvínculo na listagem e clique na setinha para ver detalhes:

Em seguida clique em Desvincular > Confirmar:

Você será encaminhado para uma página de sucesso e então à listagem, onde o desvínculo será evidenciado. O botão de Vincular ficará disponível novamente para um vínculo futuro.

Utilização em múltiplas contas Pagar.me

Quando o aplicativo VTEX Sellers é instalado, ele sempre é vinculado a uma única conta Pagar.me após sua instalação e integração com o hub, conforme o tutorial de instalação acima.

Entretanto, em alguns cenários avançados, podemos ter em uma mesma conta VTEX mais de uma conta da Pagar.me configurada.

Caso seja necessário fazer a gestão dos sellers de mais de uma conta, o caminho é utilizar a funcionalidade de múltiplas lojas da VTEX para fazer instalações adicionar do nosso aplicativo VTEX Sellers. Quando é feita uma instalação de um aplicativo na VTEX, ele é instalado apenas em uma loja específica e não na conta inteira.

O VTEX Sellers não irá aplicar os vínculos feitos apenas para a loja VTEX específica e sim para toda a conta VTEX. Para mais informações sobre a gestão de múltiplas lojas, consulte a central de ajuda da VTEX.

Ou seja, você pode tanto criar uma nova loja para fazer a instalação do aplicativo, como também utilizar uma loja já existente ou até mesmo workspaces se você for um usuário avançado de VTEX IO.