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

# Quickstart

> Faça sua primeira cobrança PIX em menos de 5 minutos

## Pré-requisitos

* Uma conta ativa na [VisePag](https://dash.visepag.com/login)
* Sua API Key (disponível no Dashboard, no menu **API**)

***

## Passo 1 — Criar uma Cobrança PIX

Faça um `POST /v1/payins` com o valor em **centavos**:

```bash cURL theme={null}
curl -X POST https://api.visepag.com/v1/payins \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1000,
    "description": "Pedido #1234",
    "customerName": "João Silva",
    "customerDocument": "52998224725",
    "customerEmail": "joao@email.com"
  }'
```

```javascript Node.js theme={null}
const response = await fetch('https://api.visepag.com/v1/payins', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    amount: 1000, // R$ 10,00 em centavos
    description: 'Pedido #1234',
    customerName: 'João Silva',
    customerDocument: '52998224725',
    customerEmail: 'joao@email.com'
  })
});

const charge = await response.json();
```

```python Python theme={null}
import requests

charge = requests.post(
    'https://api.visepag.com/v1/payins',
    headers={
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'amount': 1000,  # R$ 10,00 em centavos
        'description': 'Pedido #1234',
        'customerName': 'João Silva',
        'customerDocument': '52998224725',
        'customerEmail': 'joao@email.com'
    }
).json()
```

> [!WARNING]
>
> O campo `amount` é sempre em **centavos**. Para cobrar R\$ 10,00, envie `1000`.

**Resposta:**

```json theme={null}
{
  "id": "54e2b712-aca0-4230-b69a-d6dd8542c925",
  "status": "pending",
  "method": "pix",
  "amount": 1000,
  "expiresAt": "2026-03-06T18:14:48Z",
  "pixCopy": "00020101021226..."
}
```

***

## Passo 2 — Exibir o QR Code para o cliente

Use o campo `pixCopy` para exibir o código PIX copia-e-cola, ou o `pixQrCode` (imagem do QR Code).

```javascript theme={null}
console.log(charge.pixCopy);
```

***

## Passo 3 — Verificar o Status

Consulte o status da cobrança via polling ou configure um [Webhook](https://docs.visepag.com/concepts/webhooks.md):

```bash theme={null}
curl https://api.visepag.com/v1/payins/54e2b712-aca0-4230-b69a-d6dd8542c925 \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json theme={null}
{
  "id": "54e2b712-aca0-4230-b69a-d6dd8542c925",
  "status": "paid",
  "paidAt": "2026-03-05T18:16:22Z"
}
```

***

## Próximos Passos

> [card] [Webhooks](https://docs.visepag.com/concepts/webhooks.md)
>
> Receba notificações automáticas quando um pagamento for confirmado

> [card] [Saques](https://docs.visepag.com/api-reference/payouts/create-payout.md)
>
> Aprenda a solicitar saques via PIX

> [card] [Status](https://docs.visepag.com/concepts/status.md)
>
> Os status das cobranças e dos saques

> [card] [Erros](https://docs.visepag.com/concepts/errors.md)
>
> Referência completa de códigos de erro


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.