RevKeenDocs
StatusSupport
API Reference

Retrieve a checkout session

Retrieve a checkout session by its ID. --- **Related endpoints** - `POST /checkout-sessions` — Create a checkout session - `POST /checkout-sessions/{id}/expire` — Expire 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.

GET
/checkout-sessions/{id}

Retrieve a checkout session by its ID.

Related endpoints

  • POST /checkout-sessions — Create a checkout session
  • POST /checkout-sessions/{id}/expire — Expire 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.

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

Path Parameters

id*string

Checkout session ID.

Formatuuid

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 "https://api.revkeen.com/v2/checkout-sessions/550e8400-e29b-41d4-a716-446655440000" \
  -H "x-api-key: $REVKEEN_API_KEY"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "object": "checkout_session",    "status": "string",    "mode": "string",    "amount_total": 0,    "currency": "string",    "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",    "payment_intent_id": "7e322e88-5311-4979-b283-b9a687137f41",    "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",    "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",    "url": "string",    "success_url": "string",    "cancel_url": "string",    "expires_at": "2019-08-24T14:15:22Z",    "created_at": "2019-08-24T14:15:22Z",    "allowed_methods": [      "string"    ],    "selected_method": "string"  },  "requestId": "string"}

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).

List messages in a thread GET

List all messages in a conversation thread --- **Related endpoints** - `POST /comms/send` — Send a message - `GET /comms/threads` — List conversation threads **Common errors** - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Pagination** Offset-based with `limit` (default 25, max 100) and `offset`. The response `pagination` block includes `total` and `hasMore`. See [the pagination guide](/docs/fundamentals/pagination) for SDK auto-paging helpers.