Quickstart

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.

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.

Crie um cliente

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": "[email protected]"
  }'

Guarde o id da resposta.

Crie uma cobrança

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.

Gere o PIX

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.

Simule o pagamento

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.

Começar

Integração

Referência da API

Próximos passos

Registrar um webhook

Ir para produção

Tratar erros

Referência da API

​Próximos passos

Registrar um webhook

Ir para produção

Tratar erros

Referência da API

Próximos passos