RevKeenDocs
StatusSupport
API Reference
🔗 CheckoutCheckout Sessions

Create a checkout session

Create a checkout session for an invoice.

POST/checkout-sessions

Create a checkout session for an invoice.

Related endpoints

  • GET /checkout-sessions/{id} — Retrieve a checkout session
  • POST /checkout-sessions/{id}/expire — Expire a checkout session

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.
  • 404 resource_missing — the referenced resource does not exist or is not visible to your key.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a hosted checkout session. Customers are redirected to complete payment on a RevKeen-hosted page.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/checkout-sessions" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invoice_id": "11111111-1111-4111-8111-111111111111"
  }'

Synthetic documentation data, validated against the response schema; not a live API result.

{  "data": {    "id": "00000000-0000-4000-8000-000000000001",    "url": "https://example.com/webhooks/revkeen",    "public_token": "string",    "amount_minor": 0,    "currency": "string",    "customer_id": "00000000-0000-4000-8000-000000000001",    "expires_at": "2026-09-01T12:00:00Z",    "allowed_methods": [      "card",      "direct_debit"    ],    "selected_method": null  },  "requestId": "00000000-0000-4000-8000-000000000001"}

Put this endpoint to work

Integrate checkout

Integrate terminal payments