Documentação ValidaPay2

22 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. Os respectivos códigos estão descritos no apêndice Campos Financeiros ao final da sessão Subcontas ValidaPay

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. Os respectivos códigos estão descritos no apêndice Campos Financeiros ao final da sessão Subcontas ValidaPay

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

Saldo subcontas

GET/v1/wallet/balance

Com esta funcionalidade você pode verificar o saldo de uma ou várias subcontas > ⚠️ **Atenção:** Para consultar o saldo de várias subcontas envie o header acoountId com o número das subcontas separado por vírgula, por exemplo: 9489623,9489624,9489625

Checkouts

Checkout Transparente

POST/v1/charges

Você envia os dados do cliente, método de pagamento e itens diretamente pela API, sem redirecionar o usuário para uma página externa. Toda a experiência de compra acontece na sua própria interface (site, app, sistema) e envia os dados de pagamento para a ValidaPay. Métodos de pagamento suportados: creditcard, pix, boleto Os itens do pedido referenciam preços (priceId) previamente cadastrados via rota de produtos. Para pagamentos com cartao de crédito, os dados do cartão devem ser enviados no objeto card. Case de uso: _Como SaaS, quero oferecer assinaturas com pagamento por cartão de crédito diretamente no meu app, sem redirecionar o usuário para outra página. Cadastro meus planos como produtos, e na hora do pagamento envio o priceId do plano escolhido junto com os dados do cartão._ _Como e-commerce, quero oferecer PIX e boleto como opções de pagamento no meu próprio checkout customizado. Monto o carrinho com os priceId dos produtos, coleto os dados do cliente e processo tudo numa única chamada._

Criar Produto

POST/v1/products

Cria um novo produto vinculado a sua conta. Os produtos criados ficam disponíveis 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 preços (prices), incluindo configurações de recorrência para cobranças periódicas, conforme abaixo: - ONE_TIME → "Avulsa" - MONTHLY → "Mensal" - WEEKLY → "Semanal" - QUARTERLY → "Trimestral" - YEARLY → "Anual" Case de uso: _Como SaaS, quero cadastrar meus planos (ex: Básico, Pro, Enterprise) como produtos com preços recorrentes, para que meus clientes possam assinar diretamente pelo checkout pro ou pela minha própria interface integrada via checkout transparente._ _Como marketplace, quero cadastrar os servicos oferecidos como produtos avulsos com preço fixo, para gerar cobranças pontuais aos compradores_

Listar produtos

GET/v1/products

Liste todos os produtos criados

Checkout Session

POST/v1/checkouts/session

Esta rota cria uma sessão de pagamento e retorna um link para a página de pagamento hospedada pela ValidaPay. Ao compartilhar ou redirecionar o cliente para esse link, ele será direcionado a uma interface segura onde poderá concluir o pagamento. Para criar uma sessão, informe o priceId de um preço previamente cadastrado. Opcionalmente, você pode enviar os dados do cliente (customer) e restringir os métodos de pagamento aceitos (allowedPaymentMethods). A resposta inclui o id da sessao e uma url de pagamento que pode ser utilizada como fallback ou redirecionamento. Metodos de pagamento suportados: creditcard, pix, boleto > ⚠️ **Atenção:** Uma sessao de checkout so pode ser paga uma unica vez. Apos o pagamento bem-sucedido, a sessao e marcada como completed e novas tentativas de pagamento não serão possíveis. Case de uso: _Como SaaS, quero gerar um link de pagamento exclusivo para cada cliente no momento da contratacao do plano. Crio uma sessao com o priceId do plano escolhido e redireciono o cliente para a URL retornada. Apos o pagamento, a sessao e encerrada automaticamente, garantindo que o mesmo link nao seja utilizado novamente._ _Como plataforma de servicos, quero enviar um link de pagamento por email ou WhatsApp para cada orçamento aprovado. Cada sessao corresponde a um pagamento unico, evitando cobranças duplicadas._