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

# Quickstart

> Sua primeira integração em 5 minutos com uma chave de teste.

Você vai criar um cliente e uma cobrança, gerar um PIX e simular o pagamento. O modo teste não envia mensagens reais e não custa nada.

**1. Crie uma API key de teste**

No painel, vá em **Configurações → API & Webhooks → Criar chave** e escolha o modo **Teste**.

Copie a chave `esk_test_...` agora, ela só é exibida uma vez.

**2. Crie um cliente**

```bash theme={null}
curl -X POST "https://api.payable.run/api/v1/clients" \
  -H "Authorization: Bearer esk_test_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "João",
    "lastName": "Silva",
    "phone": "11999999999",
    "email": "joao@empresa.com"
  }'
```

Guarde o `id` da resposta.

**3. Crie uma cobrança**

```bash theme={null}
curl -X POST "https://api.payable.run/api/v1/debts" \
  -H "Authorization: Bearer esk_test_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "ID_DO_CLIENTE",
    "productName": "Mensalidade Março",
    "amount": 150.00,
    "dueDate": "2026-03-15"
  }'
```

A cobrança é **inscrita na régua automaticamente**. No modo teste, as mensagens são simuladas.

**4. Gere o PIX**

```bash theme={null}
curl -X POST "https://api.payable.run/api/v1/pix/generate-for-debt/ID_DA_COBRANCA"
```

Este endpoint é público (ele alimenta a página de pagamento do cliente), então não precisa de chave. Guarde o `id` do pagamento.

**5. Simule o pagamento**

```bash theme={null}
curl -X POST "https://api.payable.run/api/v1/test/payments/ID_DO_PAGAMENTO/simulate-paid" \
  -H "Authorization: Bearer esk_test_SUA_CHAVE"
```

Só funciona com chaves de teste. A cobrança vira paga e seus webhooks recebem `payment.received` e `debt.paid` com `"live": false`.

## Próximos passos

> **[Registrar um webhook](https://docs.payable.run/pt-BR/webhooks.md)**

> **[Ir para produção](https://docs.payable.run/pt-BR/sandbox.md)**

> **[Tratar erros](https://docs.payable.run/pt-BR/errors.md)**

> **[Referência da API](https://docs.payable.run/pt-BR/api-reference/introduction.md)**


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