DOCS

Kirvex API

Brazilian payment gateway — cards, Pix, boleto.

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

Comece agora

  • Quickstart — primeira cobrança em 5 minutos
  • Autenticação — chave de API, Idempotency-Key e assinatura dos pedidos
  • Errors — códigos de erro e como tratá-los

Reference

Conventions

  • Money: integer cents, currency BRL. JSON wire format: { "amount": "9990", "currency": "BRL" }.
  • Authentication: Authorization: Bearer sk_live_xxx or Authorization: Basic <base64(sk_live_xxx:)> — see Autenticação.
  • Idempotency: every write endpoint requires Idempotency-Key (up to 255 chars, letters, digits and _ - : .). Same key with different body returns 409 idempotency_conflict.
  • Errors: canonical envelope { error: { type, code, message, request_id, retryable } }.

On this page