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

# Conceitos

> Os quatro objetos com que você vai trabalhar e como se relacionam.

## Visão geral

```
Cliente ──< Cobrança ── inscrita na ──> Régua de cobrança ──> mensagens / ligações
                │
                └──> Pagamento (PIX) ──> webhook: payment.received, debt.paid
```

## Cliente

Pessoa ou empresa que deve a você. Os campos obrigatórios são `firstName`, `lastName` e `phone` (celular brasileiro, para onde vão WhatsApp e SMS). `email` e `cpf` são opcionais, mas melhoram a entrega e a identificação. Um cliente pode ter várias cobranças e tem preferências por canal: se ele recusa o WhatsApp, o Payable para de enviar por lá.

## Cobrança

Valor que um cliente deve, com `productName`, `amount` e `dueDate`. Uma cobrança pode ser recorrente (mensal) pelo campo `recurrence`.

Criar uma cobrança **a inscreve automaticamente na régua**. Envie `"enroll": false` se quiser apenas registrá-la.

Quite uma cobrança com `POST /debts/{id}/settle` quando receber o pagamento fora do Payable. Isso interrompe todas as mensagens.

## Régua de cobrança

É a sequência de etapas que o Payable executa para cada cobrança: um lembrete antes do vencimento, mensagens depois dele, ligações com IA opcionais, com intensidade crescente. Você configura no painel. Cada etapa usa um canal (WhatsApp, e-mail, SMS ou voz) e é pulada nos canais que o cliente recusou.

## Pagamento

Cada cobrança tem um link de pagamento público e um QR code PIX. Quando o cliente paga, a cobrança vira paga, a cobrança automática para e você recebe os webhooks `payment.received` e `debt.paid`.

## Modo teste e produção

Toda API key é `esk_test_` ou `esk_live_`, e os dois mundos são isolados: dados de teste nunca aparecem em produção e vice-versa. Use chaves de teste até a integração funcionar e depois troque a chave. Veja [Sandbox](https://docs.payable.run/pt-BR/sandbox.md).


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