Documentação ValidaPay2

15 endpoints disponíveis

Split de pagamentos

Subcontas ValidaPay

Criar subconta PF

POST/v1/proposals

Com esta funcionalidade você pode criar subcontas Pessoa Física na ValidaPay. Ao criar a subconta ela ficará associada à sua conta (chamaremos de conta Master). Case de uso: _Como SaaS tenho vários Sellers, preciso gerar cobranças para esses Sellers e receber split em cada venda._ > ⚠️ **Atenção:** Não é possivel criar uma subconta com mesmo email e telefone da _master account._ > ⚠️ **Atenção:** Dados de renda/faturamento no campo financialDetails são obrigatórios

Criar subconta PJ

POST/v1/proposals

Com esta funcionalidade você pode criar subcontas Pessoa Jurídica na ValidaPay. Ao criar a subconta ela ficará associada à sua conta (chamaremos de conta Master). Case de uso: _Como SaaS tenho vários Sellers, preciso gerar cobranças para esses Sellers e receber split em cada venda._ > ⚠️ **Atenção:** Não é possivel criar uma subconta com mesmo email e telefone da _master account._ > ⚠️ **Atenção:** Dados de renda/faturamento no campo financialDetails são obrigatórios

Status de subconta

GET/v1/proposals/:formId

@botton Quando a conta for aprovada, será enviado um evento na URL de webhook cadastrada nas rotas de criação de conta PF e PJ. O evento segue o seguinte layout: ``` json { "event": "account_approved", "status": "CONFIRMED", "account": { "account": "123456", "branch": "0001", "documentNumber": "123456789", "ispb": "13935893", "name": "Werner Heisenberg" }, "onboardingId": "fc0e6dab-8210-4f2d-8fce-2e94990b63ef", "documentNumber": "1234567889", "formId": "7b83fcb4-fe9c-4ad3-8d3a-621fe9c9ffc1", "createdAt": "2025-06-02T17:46:10.1120909" } ```

Listar Subcontas

GET/v1/accounts/subaccounts

Com esta rota você poderá listar todas as subcontas associadas à sua _master account_

Listar cobranças

GET/v1/charges

Com esta rota você poderá listar todas as cobranças que a sua _master account_ gerou em uma subcontas

Checkouts

Checkout Transparente

POST/v1/charge

Cria uma sessao de pagamento via checkout transparente. Voce envia os dados do cliente, metodo de pagamento e itens diretamente pela API, sem redirecionar o usuario para uma pagina externa. Toda a experiencia de compra acontece na sua propria interface. Metodos de pagamento suportados: creditcard, pix, boleto Os itens do pedido referenciam precos (priceId) previamente cadastrados via rota de produtos. Para pagamentos com cartao de credito, os dados do cartao devem ser enviados no objeto card. Case de uso: _Como SaaS, quero oferecer assinaturas com pagamento por cartao de credito diretamente no meu app, sem redirecionar o usuario para outra pagina. Cadastro meus planos como produtos, e na hora do pagamento envio o priceId do plano escolhido junto com os dados do cartao._ _Como e-commerce, quero oferecer PIX e boleto como opcoes de pagamento no meu proprio checkout. Monto o carrinho com os priceId dos produtos, coleto os dados do cliente e envio tudo numa unica chamada_

Criar Produto

POST/v1/products

Cria um novo produto vinculado a sua conta. Os produtos criados ficam disponiveis no painel administrativo e podem ser utilizados tanto no checkout transparente (via API) quanto no checkout pro (link de pagamento).Ao criar um produto, voce pode associar um ou mais precos (prices), incluindo configuracoes de recorrencia para cobranças periodicas. Case de uso: _Como SaaS, quero cadastrar meus planos (ex: Basico, Pro, Enterprise) como produtos com precos recorrentes, para que meus clientes possam assinar diretamente pelo checkout pro ou pela minha propria interface integrada via checkout transparente._ _Como marketplace, quero cadastrar os servicos oferecidos como produtos avulsos com preco fixo, para gerar cobranças pontuais aos compradores_

Listar produtos

GET/v1/products

Liste todos os produtos criados