> ## Documentation Index > Fetch the complete documentation index at: https://docs-alpha.pepay.io/llms.txt > Use this file to discover all available pages before exploring further. # Mint a short-lived ws_token for browser/mobile websocket auth ## OpenAPI ````yaml /api-reference/openapi.json post /api/v1/ws/token openapi: 3.0.0 info: title: Pepay API (SDK-scoped) version: 1.0.0 description: API documentation for Pepay API servers: - url: https://api-beta.pepay.io description: Beta server - url: http://localhost:3000 description: Local development security: - bearerAuth: [] tags: - name: Events description: Events API (history + debugging) for canonical notification envelopes. - name: Metrics description: Internal Prometheus metrics (restricted). - name: WebSockets description: WebSocket streams (upgrade endpoints) and message schemas. - name: Commerce - Devnet Simulator description: > Deterministic devnet-only endpoints for simulating Commerce V2 order state transitions. Use this when integrating as a merchant on devnet to test your backend/UI against realistic order lifecycle changes (payment confirmation, settlement gating, placement, tracking, cancellation, refunds) without placing real retailer orders or sending real on-chain refunds. How it works: - Requires a devnet `X-Commerce-Api-Key` (merchant-scoped). - Only operates on orders created in `networkEnvironment=devnet`. - Updates the order using the same reducer/persistence paths used in mainnet (provider snapshots are simulated). - After each simulation, Pepay emits the normal `commerce.order.updated` merchant webhook event. - name: Merchant Checkout description: > Merchant-scoped **three-step** checkout flow: 1) `POST /api/commerce/merchant/checkout/estimate` — validate items against current eligible offers and return `validItems[]` + `invalidItems[]`. 2) `POST /api/commerce/merchant/checkout/address` — attach and validate a shipping address for the estimate. 3) `POST /api/commerce/merchant/checkout/invoice` — create the final invoice + commerce order. Cart behavior (when `useCart: true`): - The estimate call **reads** the saved cart but does **not** remove or modify cart items. - Items with no eligible offers are returned in `invalidItems[]`. - To remove items from the saved cart, call the Merchant Cart APIs (`PUT /api/commerce/merchant/carts/items/:itemId` with `quantity: 0`, or `DELETE /api/commerce/merchant/carts/items/:itemId`). - To exclude items for *this checkout attempt* without mutating the cart, use `itemOverrides[]` with `quantity: 0`. - name: Payment Sessions description: > Payor-facing APIs used by the hosted payment page and other embedded checkout clients. Canonical base path: - All documented endpoints are under `/api/v1/payments/*`. Authentication: - These endpoints do **not** accept merchant API keys or bearer JWTs. - Send `x-session-token` and `x-signature` headers on every request (both are returned when creating an invoice). Typical flow: 1) Create an invoice (`POST /api/v1/invoices`) → receive `payment_url`, `session_token`, `signature`. 2) Render/open the `payment_url` for the payor. 3) Fetch invoice context (`GET /api/v1/payments/session-details`). 4) List supported tokens (`GET /api/v1/payments/available-tokens`). 5) Allocate a payment address (`POST /api/v1/payments/payment-addresses`) → use `ws_connection` for `/ws/payment`. 6) Track progress via polling (`GET /api/v1/payments/payment-status`) and/or websocket (`/ws/payment`). Security notes: - Treat `session_token` and `signature` as sensitive values (anyone with them can read the invoice/payment status). - Do not store them in long-lived browser storage; prefer in-memory usage on the payment page. - name: Quotes description: Token settlement quotes and rate calculations - name: Webhooks description: > Webhook endpoint management and delivery history for canonical notifications. Delivery model: - At-least-once delivery; receivers must dedupe by `event.id` (also sent as `X-Pepay-Event-ID`). - Payloads are canonical `PepayEvent` objects and match websocket `event_v1` frames for the same event type. Security: - Endpoints must be HTTPS. - Deliveries are signed using `HMAC_SHA256("${timestamp_ms}.${raw_body}")` and sent in `X-Pepay-Signature`. paths: /api/v1/ws/token: post: tags: - WebSockets summary: Mint a short-lived ws_token for browser/mobile websocket auth requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/Postapiv1wstokenRequest' responses: '200': description: Token minted content: application/json: schema: $ref: '#/components/schemas/WsTokenMintResponse' examples: merchant: summary: Merchant ws_token value: success: true data: token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... scope: merchant merchant_id: 123 network_environment: null expires_at: 1766320496 ws_url: wss://api-beta.pepay.io/ws/merchant/events commerce: summary: Commerce ws_token value: success: true data: token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... scope: commerce merchant_id: 123 network_environment: devnet expires_at: 1766320496 ws_url: wss://api-beta.pepay.io/ws/commerce/events '400': description: Invalid request (scope/ttl validation) '401': description: Invalid API key security: - merchantApiKey: [] - commerceApiKey: [] components: schemas: Postapiv1wstokenRequest: type: object properties: scope: type: string enum: - merchant - commerce ttl_seconds: type: integer example: 60 WsTokenMintResponse: type: object description: Standard ws_token mint response envelope. properties: success: type: boolean example: true data: $ref: '#/components/schemas/WsTokenMintData' WsTokenMintData: type: object description: >- Minted ws_token payload. Use `data.token` as `token=` when connecting to `/ws/*` streams. properties: token: type: string description: Short-lived JWT used to authenticate websocket streams. example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... scope: type: string enum: - merchant - commerce description: Scope for the minted token. merchant_id: type: integer description: Merchant id associated with the token. example: 123 network_environment: type: string enum: - devnet - mainnet nullable: true description: >- Commerce tokens are scoped to an environment; merchant tokens may be null. expires_at: type: integer description: Epoch seconds when the token expires. ws_url: type: string description: Convenience websocket URL for the scope’s primary stream. example: wss://api-beta.pepay.io/ws/merchant/events securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT token for wallet authentication merchantApiKey: type: apiKey in: header name: x-api-key description: API key for server-to-server operations (scope=merchant or commerce) commerceApiKey: type: apiKey in: header name: x-commerce-api-key description: >- Legacy alias for commerce-scoped API keys. Prefer `x-api-key` with scope=commerce. ````