Create a customer-portal session
Mint a short-lived bearer token that authenticates a specific customer against /v2/customer-portal/*. Returns an opaque rkcps_... token that expires in 60 minutes by default. Call this server-side from the merchant's backend, then hand the token to the customer's browser or embedded client. Treat the token like a password — never log it and never expose it to untrusted code.
/customer-portal/sessionsMint a short-lived bearer token that authenticates a specific customer against /v2/customer-portal/*. Returns an opaque rkcps_... token that expires in 60 minutes by default. Call this server-side from the merchant's backend, then hand the token to the customer's browser or embedded client. Treat the token like a password — never log it and never expose it to untrusted code.
Related endpoints
GET /customer-portal/customer— Retrieve the authenticated customerGET /customer-portal/subscriptions— List the authenticated customer's subscriptionsGET /customer-portal/subscriptions/{id}— Retrieve a subscriptionPOST /customer-portal/subscriptions/{id}/cancel— Cancel a subscriptionGET /customer-portal/invoices— List the authenticated customer's invoicesGET /customer-portal/invoices/{id}— Retrieve an invoiceGET /customer-portal/mandates— List the authenticated customer's Direct Debit mandatesPOST /customer-portal/mandates/{id}/re-authorize— Re-authorise a Direct Debit mandate with new bank details
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 aWWW-Authenticate: Bearerchallenge.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.
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 customer-portal session. The authenticated merchant must already own the referenced customer.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.revkeen.com/v2/customer-portal/sessions" \
-H "x-api-key: $REVKEEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"customer_id": "11111111-1111-4111-8111-111111111111"
}'Synthetic documentation data, validated against the response schema; not a live API result.
{ "data": { "id": "cpses_kw2e9b0zqrl1x8mv", "token": "rkcps_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.xxx.yyy", "customer_id": "c2a1e7d4-5b3f-4a8e-9d21-6f0b3e4c7a11", "expires_at": "2026-04-18T13:00:00.000Z", "created_at": "2026-04-18T12:00:00.000Z" }}