Skip to main content

​
Velfy Payments API

Receba pagamentos via PIX, cartão de crédito e boleto, e envie transferências PIX — tudo por uma única API.
A Velfy Payments é a API de pagamentos da Velfy. Com poucas integrações você consegue:
  • Receber cobranças via PIX, cartão de crédito e boleto bancário
  • Enviar transferências PIX Out (saques) para qualquer chave PIX
  • Acompanhar cada pagamento em tempo real através de webhooks
  • Consultar saldo e extrato da sua conta
Esta seção (Documentação) explica os conceitos e o funcionamento de cada parte do sistema. Para a lista completa de endpoints, parâmetros e respostas, use a aba Referência da API.

​
Como o sistema funciona

Toda a operação da Velfy Payments gira em torno de dois fluxos:
1

Entrada (cash-in)

Você cria uma cobrança em POST /api/v1/transactions, informando o método de pagamento (pix, credit_card ou boleto). O cliente paga, e você recebe a confirmação via webhook.
2

Saída (cash-out)

Você solicita uma transferência PIX para fora da sua conta Velfy em POST /api/v1/cashOut/request, informando o valor e a chave PIX de destino.
Ambos os fluxos são autenticados com as mesmas credenciais — veja como funciona em Autenticação.

​
Por onde começar

Autenticação

Obtenha suas credenciais e autentique suas requisições

PIX

Gere cobranças instantâneas com QR Code

Cartão de Crédito

Tokenize cartões e processe cobranças

Boleto

Gere boletos bancários registrados

PIX Out

Envie transferências PIX para qualquer chave

Webhooks

Receba notificações em tempo real de cada evento

​
Referência completa

Precisa dos detalhes técnicos — todos os campos, tipos e exemplos de resposta de cada endpoint? Veja a aba Referência da API.