Kirvex API

Documentação técnica da API pública do Kirvex.

Comece agora

• Quickstart — primeira cobrança em 5 minutos
• Errors — códigos de erro e como tratá-los

Reference

• POST /v1/charges — criar cobrança
• /openapi.json — spec OpenAPI 3.1 completa
• npm install @kirvex/sdk — SDK TypeScript oficial

Conventions

• Money: integer cents, currency BRL. JSON wire format: { "amount": "9990", "currency": "BRL" }.
• Authentication: Authorization: Basic <base64(sk_test_xxx:)>.
• Idempotency: every write endpoint requires Idempotency-Key (16-128 chars, alphanumeric + dashes). Same key with different body returns 409 idempotency_conflict.
• Errors: canonical envelope { error: { type, code, message, request_id, retryable } }.