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

# API Avantti Finance

> Documentação completa para integração com a API Avantti Finance.

<Note>
  **Versão:** 1.0 · **Ambiente de produção:** `https://api.avanttifinance.com`
</Note>

Bem-vindo à documentação oficial da API Avantti Finance! Nossa API foi desenvolvida para simplificar integrações de pagamentos PIX, oferecendo uma solução robusta e fácil de usar para desenvolvedores.

<img className="rounded-lg dark:hidden" title={true} alt="Click Pagamentos" src="https://mintcdn.com/clickpagamentos/RBVFlwlSQgyrRWqY/Frame1.png?fit=max&auto=format&n=RBVFlwlSQgyrRWqY&q=85&s=806f41225ece0518723dc9d7fbe67531" width="1920" height="1080" data-path="Frame1.png" />

<img className="rounded-lg hidden dark:block" title={true} alt="Click Pagamentos" src="https://mintcdn.com/clickpagamentos/RBVFlwlSQgyrRWqY/images/hero-dark.png?fit=max&auto=format&n=RBVFlwlSQgyrRWqY&q=85&s=eb8cf58cc0d85b063fa6be4b763e0662" width="1920" height="1080" data-path="images/hero-dark.png" />

## O que você pode fazer com nossa API

Nossa API oferece funcionalidades completas para pagamentos PIX:

<Tabs>
  <Tab title="PIX IN - Recebimento">
    Crie QR Codes PIX para receber pagamentos de forma instantânea e segura.

    ```bash theme={null}
    curl -X POST 'https://api.avanttifinance.com/v1/pix/in/qrcode' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer <seu_token>' \
      -d '{
        "amountInCents": 5000,
        "postbackUrl": "https://nimble-swan-74.webhook.cool",
        "description": "Teste",
        "customer": {
          "name": "TESTE VENDA",
          "email": "JVTESTE@teste.com",
          "documentType": "cnpj",
          "document": "54689584000183",
          "phone": "(32) 98518-2841"
        },
        "items": [
          {
            "title": "Produto teste",
            "tangible": true,
            "quantity": 1,
            "amountInCents": 2000,
            "shippingAddress": {
              "street": "Rua Teste",
              "number": "293",
              "neighborhood": "Bairro",
              "city": "São Paulo",
              "state": "SP",
              "zipCode": "123982193892183"
            }
          },
          {
            "title": "Produto teste 2",
            "tangible": true,
            "quantity": 1,
            "amountInCents": 3000,
            "shippingAddress": {
              "street": "Rua Teste",
              "number": "293",
              "neighborhood": "Bairro",
              "city": "São Paulo",
              "state": "SP",
              "zipCode": "123982193892183"
            }
          }
        ],
        "seller": {
          "name": "Bruno Ribeiro do Vale",
          "documentType": "cnpj",
          "document": "07628652000114",
          "phone": "(32) 88888-9999"
        }
      }'
    ```
  </Tab>

  <Tab title="PIX OUT - Envio">
    Realize transferências PIX para qualquer chave PIX de forma programática.

    ```bash theme={null}
    curl -X POST 'https://api.avanttifinance.com/v1/pix/out/transfer' \
      --header 'x-idempotency-key: idempotencykey222222' \
      --header 'Content-Type: application/json' \
      --header 'Authorization: Bearer <seu_token>' \
      --data-raw '{
          "pixKey": "testeuser@gmail.com",
          "amount": 300,
          "password": "111111"
      }'
    ```
  </Tab>

  <Tab title="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": "clm8x9y0z1234567890abcdef",
        "amount": 29990,
        "status": "paid"
      }
    }
    ```
  </Tab>
</Tabs>

## Arquitetura simples e poderosa

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

<CardGroup cols={2}>
  <Card title="Idempotente" icon="repeat">
    Execute a mesma requisição quantas vezes precisar, sem efeitos colaterais:

    ```http theme={null}
    X-Idempotency-Key: operacao_unica_12345
    ```
  </Card>

  <Card title="Consistente" icon="list-checks">
    Sempre retornamos uma estrutura padronizada:

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

## Comece agora

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" 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="paper-plane" href="/pages/pix-out/overview">
    Envie transferências PIX programaticamente
  </Card>

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

## Ambientes disponíveis

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

## Suporte e recursos

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

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

  <Card title="Referência Completa" 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.clickpagamentos.com">
    Monitore o status dos nossos serviços
  </Card>
</CardGroup>

***

**Contato:** [dev@clickpagamentos.com](mailto:dev@clickpagamentos.com) · **Horário**: Segunda a Sexta, 08h às 18h (BRT)

**Bug Bounty**: Temos programa de recompensas para vulnerabilidades