API Reference

The RevKeen API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

export REVKEEN_API_KEY=rk_sandbox_your_api_key
curl https://staging-api.revkeen.com/v2/customers \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Accept: application/json"

Base URL

https://api.revkeen.com/v2

Use https://staging-api.revkeen.com/v2 for test mode. No real charges are created in test mode.

Authentication

All API requests require authentication. Send your merchant API key in the x-api-key header, or as Authorization: Bearer <key> — both are accepted:

curl https://api.revkeen.com/v2/invoices \
  -H "x-api-key: rk_live_..."

Create and manage API keys in Dashboard → Settings → Developer. See Authentication for scopes, IP allowlists, rolling, and OAuth 2.1.

Rate limits

Rate-limited responses return 429 Too Many Requests with type: rate_limit_error, code: rate_limit_exceeded, and a Retry-After header in whole seconds. Where the limiter publishes them, X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset (a UNIX timestamp in seconds) accompany the response. See Errors.

Idempotency

All POST endpoints accept an Idempotency-Key header (UUID v4 recommended). Keys are valid for 24 hours. Duplicate requests within the TTL return the original response. See Idempotency.

Versioning

The API is versioned by date. Pin a version via the RevKeen-Version header:

RevKeen-Version: 2026-05-01

Browse by category