Skip to main content

Base URL

Todas as requisições devem ser feitas para a seguinte URL base:
A API segue o padrão REST, aceita e retorna JSON em todas as rotas.

Versionamento

Todas as rotas estão prefixadas com /v1:

Autenticação

A API aceita dois tipos de autenticação via header Authorization: Bearer:
  • JWT — para uso no seu backend ou durante o desenvolvimento
  • API Key (lk_...) — recomendado para integrações server-side em produção
Veja a seção Autenticação para mais detalhes.

Formato dos valores monetários

Todos os valores monetários são representados em centavos (inteiros), sem decimais.
Nunca envie valores com casas decimais. amount: 10.50 será rejeitado — use amount: 1050.

Formato de erros

Todos os erros retornam um JSON com o campo message:
Códigos de status HTTP utilizados:

Rate limiting

Quando o limite é excedido, a API retorna 429 Too Many Requests.

Idempotência

A rota de criação de cobranças suporta o header x-idempotency-key. Envie uma chave única por operação para evitar cobranças duplicadas em caso de timeout ou retry.
Se uma cobrança com a mesma chave já existir, a API retorna a cobrança original em vez de criar uma nova.