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

# API Vexy Bank – Guia de Integração

> Integre a API Vexy Bank com exemplos e referências objetivas

Versão 1.0\
Produção: `https://api.vexybank.com`

***

## Funcionalidades

Nossa API oferece funcionalidades completas para pagamentos PIX:

### PIX IN — Recebimento

Crie QR Codes PIX para receber pagamentos de forma instantânea e segura.

```bash theme={null}
curl -X POST 'https://api.vexybank.com/api/v1/pix/in/qrcode' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <seu_token>' \
  -d '{
    "amountInCents": 10000,
    "description": "Assinatura - Plano Exemplo",
    "customer": {
      "name": "Cliente Exemplo Silva",
      "email": "cliente@exemplo.com",
      "documentType": "cpf",
      "document": "11122233344"
    }
  }'
```

### PIX OUT — Envio

Realize transferências PIX para qualquer chave PIX de forma programática.

```bash theme={null}
curl -X POST 'https://api.vexybank.com/api/v1/pix/out/pixkey' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <seu_token>' \
  -H 'X-Idempotency-Key: transfer_unique_id' \
  -d '{
    "pixKey": "contato@empresa.com.br",
    "amount": 150000,
    "description": "Pagamento de fornecedor"
  }'
```

### Webhooks

Receba notificações automáticas sobre mudanças de status em tempo real.

```json theme={null}
{
  "id": "wh_64f8a2b1c3d4e5f6g7h8i9j0",
  "type": "transaction",
  "event": "transaction_paid",
  "transaction": {
    "id": "trx_1a2b3c4d5e6f7g8h9i0j",
    "amount": 29990,
    "status": "paid"
  }
}
```

## Arquitetura

Nossa API foi construída com três princípios fundamentais:

### Design orientado à ação

Cada endpoint representa exatamente o que você precisa fazer:

* `POST /api/v1/pix/in/qrcode` - Criar QR Code para receber
* `POST /api/v1/pix/out/pixkey` - Enviar PIX para chave
* `GET /api/v1/webhook` - Listar webhooks

### Idempotência

Execute a mesma requisição quantas vezes precisar, sem efeitos colaterais:

```http theme={null}
X-Idempotency-Key: idempotency_exemplo_001
```

### Respostas padronizadas

Sempre retornamos uma estrutura padronizada:

```json theme={null}
{
  "success": true,
  "message": "Operação realizada com sucesso",
  "data": { /* seus dados aqui */ }
}
```

## Primeiros passos

<CardGroup cols={2}>
  <Card title="Autenticação" icon="shield-halved" href="/pages/auth/getting-started">
    Obtenha suas credenciais e gere seu primeiro token de acesso
  </Card>

  <Card title="PIX IN (Receber)" icon="qrcode" href="/pages/pix-in/overview">
    Crie QR Codes PIX para receber pagamentos
  </Card>

  <Card title="PIX OUT (Enviar)" icon="bolt" href="/pages/pix-out/overview">
    Envie transferências PIX programaticamente
  </Card>

  <Card title="Webhooks" href="/webhook">
    Configure notificações automáticas em tempo real
  </Card>
</CardGroup>

## Ambientes

| Ambiente     | URL Base                   | Uso           |
| ------------ | -------------------------- | ------------- |
| **Produção** | `https://api.vexybank.com` | Operação real |

## Suporte e recursos

<CardGroup cols={2}>
  <Card title="Suporte técnico" icon="phone" href="mailto:dev@vexybank.com">
    Nossa equipe está pronta para ajudar você
  </Card>

  <Card title="Segurança" href="/security">
    Conheça nossas práticas de segurança
  </Card>

  <Card title="Referência da API" icon="book-open" href="/api-reference/introduction">
    Explore todos os endpoints disponíveis
  </Card>

  <Card title="Status da API" icon="chart-line" href="https://status.vexybank.com">
    Monitore o status dos nossos serviços
  </Card>
</CardGroup>

***

## Contato

Suporte técnico: [dev@vexybank.com](mailto:dev@vexybank.com)\
**WhatsApp**: +55 11 99999-9999\
**Horário**: Segunda a Sexta, 08h às 18h (BRT)