Documentação que explica as configurações que a empresa do tipo marketplace pode ter, como é o fluxo dentro da Pagaleve e exemplos de API até a conclusão
Fluxo
O fluxo para o marketplace não difere do fluxo para empresas comuns, apresentado aqui: Fluxo de Integração.
A diferença é que na criação do pedido, o marketplace pode enviar o campo seller_id nos itens. Essa informação é opcional, mas importante em certos casos, quando se quer garantir que na captura o valor total capturado de um seller não seja maior do que o valor do mesmo vendido através da soma dos seus ítens no pedido.
Outra informação que muda para o marketplace é o envio do campo recipients na criação do Pagamento, este campo serve para informar os valores e configurações dos lojistas envolvidos na operação.
{
"amount": 3000,
"checkout_id": "2a21ce54-04c1-4ec3-81eb-6d46d5df8000",
"currency": "BRL",
"intent": "CAPTURE",
"reference": "47EAEC72B7F74B08BB0B581ADA827000",
"recipients": [
{
"provider_id": "example-marketplace",
"name": "Marketplace de Teste 01",
"role": "marketplace",
"amount": 300,
"charge_processing_fee": true,
"chargeback_liable": true
},
{
"provider_id": "example-seller",
"name": "Lojista 10",
"role": "seller",
"amount": 2700,
"charge_processing_fee": false,
"chargeback_liable": false,
"commission_amount": 300
}
]
}
O exemplo acima, é o corpo de uma requisição para a API de criação de pagamento. Nela é possível analisar o campo recipients com as informações dos lojistas.
O marketplace "Marketplace de Teste 01" neste caso não realizou nenhuma venda, apenas está recebendo R$3,00 de comissão do seller "Lojista 10". O lojista vendeu R$30,00. Este pagou a comissão de R$3,00 e receberá R$27,00. No caso, acima o marketplace foi configurado para ser responsável pelas taxas da Pagaleve, tanto de venda quanto de reembolso. Então ele receberá R$3,00 - Taxas da pagaleve configuradas em seu cadastro.
Mais informações sobre os calculos de taxas podem ser encontrados aqui.
Estrutura e configuração
A Pagaleve fornece suporte para o Split de Liquidações, o que significa que suportamos empresas do tipo Marketplace e Sellers, esse comportamento está explicado na página Split de Liquidações. Nela pode-se observar que é possível configurar quais serão os lojistas responsáveis pelo pagamento das taxas.
Informações importantes
- Apenas o marketplace recebe as comissões dos sellers
- Os sellers não precisam ter um usuário e senha. Esta é uma informação opcional no cadastro dos mesmos. O usuário e senha é utilizado tanto para acesso dos mesmos a API quanto no Dashboard.
- O campo provider_id tanto no seller quanto no marketplace representa o ID das lojas no lado do varejista. Eles precisam ser fornecidos no momento do cadastro. É através dele que fazemos o link entre as empresas do lado da Pagaleve e do varejista. Esta informação será o valor do campo seller_id na criação do pagamento ou na criação dos ítens do pedido.
Configurações do marketplace junto a Pagaleve
São configurações realizadas no momento de cadastro da empresa junto a Pagaleve. Estas configurações são internas e podem ser ajustas solicitando ao nosso time de suporte.
Responsável pelo cálculo de comissões
É possível definir quem será responsável pelo cálculo das comissões. Há duas opções:
- Marketplace: Utilizado quando na criação do pagamento, a comissão em centavos já é enviada pelo marketplace. Neste caso, a porcentagem de comissão configurada no seller é ignorada.
{
"amount": 3000,
"checkout_id": "2a21ce54-04c1-4ec3-81eb-6d46d5df8000",
"currency": "BRL",
"intent": "CAPTURE",
"reference": "47EAEC72B7F74B08BB0B581ADA827000",
"recipients": [
{
"provider_id": "example-marketplace",
"name": "Marketplace de Teste 01",
"role": "marketplace",
"amount": 300,
"charge_processing_fee": true,
"chargeback_liable": true
},
{
"provider_id": "example-seller",
"name": "Lojista 10",
"role": "seller",
"amount": 2700,
"charge_processing_fee": false,
"chargeback_liable": false,
"commission_amount": 300
}
]
}
No exemplo acima, o marketplace já envia a comissão calculada.
- Pagaleve: O campo de requisição na criação do pagamento pode ser mandado zerado, pois será ignorado. Iremos utilizar a comissão configurada no cadastro do Seller dentro da Pagaleve. Isso significa que se um seller está configurado com taxa de comissão de 20%, será aplicado essa taxa no valor total da compra para o mesmo.
Pré registro de sellers automático (Somente VTEX)
Caso o marketplace utilize a plataforma VTEX, fazemos um pré cadastro automático dos lojistas caso a empresa seja cadastrada com uma flag específica ativada. Também é necessário informar qual o ID da loja na VTEX, internamente esse valor ficará no campo provider_id.
O pré cadastro será com as informações básicas da empresa que estiverem disponíveis na VTEX. A loja dentro da Pagaleve ficará com status pendente. O que significa que esta não recebe transferências até que complete seu cadastro, fornecendo dados bancários, endereço e etc.
Comissão padrão
O marketplace é configurado com uma comissão padrão, esta serve para ser aplicada a novos lojistas que são pré cadastrados quando estes não existem dentro da Pagaleve.
Exemplo: Supondo que todos os lojistas hoje existentes estejam cadastrados com 20% de comissão, mas o Marketplace está configurado com uma comissão padrão de 10%. Quando ocorrer uma venda e na criação do pagamento for informado um provider_id que não existe na base da Pagaleve, iremos pré-cadastrar a loja com a comissão padrão de 10% e neste pedido iremos já aplicar os 10% de comissão, caso a Pagaleve esteja configurada para calcular as comissões.
Enviar os recipients somente no momento da captura do Pagamento
Na Pagaleve é possível criar um pagamento do tipo autorização, isso significa que o lojista alocou o montante da compra para ser recebido mas precisa confirmar, por exemplo, que possuí os itens em seu estoque. Caso ele possua, pode fazer a captura do valor e se não possuir, fazer o release.
Dentro deste cenário, pode ser que o marketplace apenas informe quais são sellers que receberão os valores no momento de captura do pagamento, ou seja, a requisição de criação de pagamento será feita da seguinte forma:
{
"amount": 3000,
"checkout_id": "2a21ce54-04c1-4ec3-81eb-6d46d5df8000",
"currency": "BRL",
"intent": "AUTH",
"reference": "47EAEC72B7F74B08BB0B581ADA827000"
}
Então o pagamento ficará com status de AUTHORIZED. O marketplace depois de confirmar os ítens fará a captura do mesmo, informando os recipients, como no exemplo abaixo:
{
"amount": 3000,
"checkout_id": "2a21ce54-04c1-4ec3-81eb-6d46d5df8000",
"currency": "BRL",
"intent": "CAPTURE",
"reference": "47EAEC72B7F74B08BB0B581ADA827000",
"recipients": [
{
"provider_id": "example-marketplace",
"name": "Marketplace de Teste 01",
"role": "marketplace",
"amount": 300,
"charge_processing_fee": true,
"chargeback_liable": true
},
{
"provider_id": "example-seller",
"name": "Lojista 10",
"role": "seller",
"amount": 2700,
"charge_processing_fee": false,
"chargeback_liable": false,
"commission_amount": 300
}
]
}
Todos os pagamentos serem do tipo autorização (Somente VTEX)
É possível configurar para os clientes da plataforma VTEX que todas as capturas sejam do tipo AUTH, para que o marketplace manualmente possa efeturar a captura dos pedidos posteriormente.
Exibir página no Dashboard para os pagamentos autorizados
Quando o marketplace for criar pagamentos do tipo autorização, temos uma página para estes visualizarem os pedidos com status autorizados e acompanhar se os valores dos mesmos já foram capturados ou não.
Cadastro de lojistas
Há duas opções de cadastro de sellers pelo marketplace na Pagaleve
Cadastro pelo Dashboard
O Dashboard da Pagaleve permite gerenciar os lojistas, cadastrando-os, visualizando seus status, comissões e etc. Lembrando que não é necessário informar um usuário e senha no momento do cadastro.
Enviando um CSV com todas as informações de sellers
Para essa opção, basta entrar em contato com nosso time de operações. Eles irão fornecer uma planilha de exemplo que deverá ser preenchida com todas as informações dos sellers. Iremos fazer a importação das informações em nosso backoffice.
Pré cadastro automático na captura do pagamento
Quando uma venda ocorrer e o marketplace passar um provider_id de um seller que não está presenta na base da Pagaleve, iremos efetuar o pré cadastro do mesmo e aplicar a taxa de comissão padrão cadastrada no marketplace.
O seller neste caso irá ser cadastrado com status pendente, o que significa que não irá receber transferências e os valores irão acumular até que este preencha o cadastro. Ao preencher o cadastro completo do mesmo pelo Dashboard ou mandando um CSV para o time de operações, o status passa automaticamente para completo e a transferência será gerada em D+2.
OBS: A taxa de comissão só irá interferir no cálculo se o marketplace estiver configurado para a Pagaleve calcular as taxas.
No exemplo abaixo, um seller é cadastrado com um provider_id "new-example-seller", que não existe na base da Pagaleve. Será cadastrado com status pendente.
{
"amount": 3000,
"checkout_id": "2a21ce54-04c1-4ec3-81eb-6d46d5df8000",
"currency": "BRL",
"intent": "CAPTURE",
"reference": "47EAEC72B7F74B08BB0B581ADA827000",
"recipients": [
{
"provider_id": "example-marketplace",
"name": "Marketplace de Teste 01",
"role": "marketplace",
"amount": 300,
"charge_processing_fee": true,
"chargeback_liable": true
},
{
"provider_id": "new-example-seller",
"name": "Lojista Novo",
"role": "seller",
"amount": 2700,
"charge_processing_fee": false,
"chargeback_liable": false,
"commission_amount": 300
}
]
}