RevKeenDocs
StatusSupport
API Reference

Create a checkout session

Create a checkout session for an invoice or product. --- **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](/docs/fundamentals/idempotency).

POST
/checkout-sessions

Create a checkout session for an invoice or product.

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

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 '{
    "invoiceId": "inv_123",
    "productId": "prod_123",
    "amountMinor": 1000,
    "currency": "USD",
    "successUrl": "https://example.com/success",
    "cancelUrl": "https://example.com/cancel",
    "allowedMethods": [
      "card",
      "direct_debit"
    ],
    "companionDeviceId": "00000000-0000-0000-0000-000000000000"
  }'
{  "data": {    "id": "string",    "url": "string",    "public_token": "string",    "amount_minor": 0,    "currency": "string",    "customer_id": "string",    "expires_at": "2019-08-24T14:15:22Z",    "allowed_methods": [      "string"    ],    "selected_method": "string"  },  "requestId": "string"}

Refund charge POST

Refund a charge. You can refund the full amount or specify a partial refund amount. Multiple partial refunds can be issued until the full amount is refunded. --- **Related endpoints** - `POST /charges` — Create a one-time charge - `GET /charges` — List charges - `GET /charges/{id}` — Get charge - `POST /charges/{id}/capture` — Capture charge **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](/docs/fundamentals/idempotency).

Expire a checkout session POST

Manually expire an open checkout session. Only sessions with status 'open' or 'pending' and no active payment attempt can be expired. --- **Related endpoints** - `POST /checkout-sessions` — Create a checkout session - `GET /checkout-sessions/{id}` — Retrieve a checkout session **Common errors** - `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. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).