> ## Documentation Index
> Fetch the complete documentation index at: https://docs.velfy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Como funciona a Velfy Payments API

# 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:

<Steps>
  <Step title="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.
  </Step>

  <Step title="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.
  </Step>
</Steps>

Ambos os fluxos são autenticados com as mesmas credenciais — veja como funciona em [Autenticação](/guides/authentication).

## Por onde começar

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/guides/authentication">
    Obtenha suas credenciais e autentique suas requisições
  </Card>

  <Card title="PIX" icon="qrcode" href="/guides/pix">
    Gere cobranças instantâneas com QR Code
  </Card>

  <Card title="Cartão de Crédito" icon="credit-card" href="/guides/credit-card">
    Tokenize cartões e processe cobranças
  </Card>

  <Card title="Boleto" icon="barcode" href="/guides/boleto">
    Gere boletos bancários registrados
  </Card>

  <Card title="PIX Out" icon="money-bill-transfer" href="/guides/pix-out">
    Envie transferências PIX para qualquer chave
  </Card>

  <Card title="Webhooks" icon="webhook" href="/guides/webhooks">
    Receba notificações em tempo real de cada evento
  </Card>
</CardGroup>

## 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**](/api-reference/payments/authentication).