---
# System prepended metadata

title: VenturiX <> VindimoPay
tags: [Integration, Partnership, BaaS]

---

---
title: 'VenturiX <> VindimoPay'
disqus: eltonea
---

## Table of Contents

[TOC]

## O Vindimo App
> O vindimoApp disponibiliza aos pais e alunos a visualização do boletim de notas e o acompanhamento da vida acadêmica dos alunos.

**Além disso o vindimoApp permite que os pais visualizem a sua situação financeira junto à Instituição de Ensino e emitam a segunda via do boleto bancário.**

> Dessa forma o vindimoApp disponibiliza as informações dos alunos da Instituição de Ensino de maneira sistêmica, cobrindo todo o escopo do requisito comunicação.

## O desafio
Atualmente o faturamento empregado é falho, pois para gera uma especificidade em cada escola, devido a preferência de gateway de pagamento, taxas etc.

Com isso temos a oportunidade de somar um grande faturamento unindo todas as escolhas e conseguindo um preço melhor para todas. 


## A solução
A solução se baseia numa API transacional que permitirá através dos parametros passados permitirá a gestão financeira completa da escola, desde cobrança, consulta de saldo e saque. 

A ideia é que através das nossas APIs as escolas gerem as cobrança para os pais dos alunos atravez do sistema da nossa api de pagamento (VindimoPay);

Além disso um % da transação (pagamento) deve ficar na conta da Vindimo, e outra na conta da escola, isso deve ser feito de maneira configurável (insumo para o split de pagamento);
	
A ideia é que a conta da zoop seja feita dentro do marketplace VenturiX, e o Vindimo seja um vendedor associado a VenturiX, e as escolas associadas a conta Vindimo.


## O cenário atual
Hoje em dia a api é somente um encapsulamento da api da juno.
		
A ideia é criarmos o cadastro das escolas, junto com as informações de quanto será o % para cada parte da transação (Vindimo e Escola).

Pensando de uma forma genérica:

1. Vamos cadastrar nosso clientes diretos e os clientes dos nossos clientes;
				
2. No caso nosso cliente direto é o vindimo;

3. Os clientes dele são as escolas (clientes dos nossos clientes) -> `nossos clientes cadastrados podem ter uma prop para identificar quem é sub vendedor`
			
	
	
4. Criar novos endpoints para:
		
    4.1. Cadastrar as escolas como vendedores (clientes venturi e clientes dos nossos clientes):
			 https://api.zoop.ws/v1/marketplaces/{marketplace_id}/sellers/businesses

	4.2. Atualizar dados
			https://api.zoop.ws/v1/marketplaces/{marketplace_id}/sellers/businesses/{seller_id}
		
    4.3. Enviar documentos: 
			https://api.zoop.ws/v1/marketplaces/{marketplace_id}/sellers/{seller_id}/documents

	4.4. O cadastro de dados bancários é feito em endpoint separados:
			https://api.zoop.ws/v1/marketplaces/{marketplace_id}/bank_accounts/tokens
    
    4.5. Apos criar o token deve se associar ao vendedor:
				https://api.zoop.ws/v1/marketplaces/{marketplace_id}/bank_accounts
		
	4.6. O obter o saldo da conta: 
			https://api.zoop.ws/v1/marketplaces/{marketplaceId}/sellers/{seller_id}/balances
			
	4.7. Obter o extrato da conta:
			https://api.zoop.ws/v1/marketplaces/{marketplaceId}/sellers/{seller_id}/balances/history
		
	4.8. Transferir o dinheiro da conta zoop para a conta bancaria cadastrada:
			 https://api.zoop.ws/v1/marketplaces/{marketplace_id}/bank_accounts/{bank_account_id}/transfers sei se é esse endpoint que fara por exemplo, uma escola receber o dinheiro na conta dela;
			 
	4.9. Gerar uma cobrança:
			https://api.zoop.ws/v1/marketplaces/{marketplace_id}/transactions
			
    4.10. Podem ser geradas cobranças: pix, boleto, cartao de debito e credito
				Usar o campo on_behalf_of para identificar o vendedor;
			Antes de gerar a cobraça sera necessario cadastrar o comprador:
				https://api.zoop.ws/v1/marketplaces/{marketplace_id}/buyers
    
    4.11. Antes de cadastrar o comprador verificar se ele ja esta cadastrado:
				https://api.zoop.ws/v1/marketplaces/{marketplace_id}/buyers/search
				
			
	4.12. Estornar uma cobrança:
			https://api.zoop.ws/v1/marketplaces/{marketplace_id}/transactions/{transaction_id}/void
			
	4.13. Será necessário criar webhooks para os clientes:
			https://api.zoop.ws/v1/marketplaces/{marketplace_id}/webhooks

## Dúvidas

[André Jr., Staff Engineer](mailto:aluiz@vntrx.com)


###### tags: `Integration` `Partnership` `BaaS`
