STstreampay
Consumer Portal Sessions

Create a consumer portal session

Changed on

Creates a short-lived, single-use portal session token for a merchant-owned consumer. The returned URL can be used to redirect the consumer or embed the portal in an iframe.

post/api/v2/consumer_portal/sessions

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Request body

organization_consumer_idstring uuid required
subscription_idstring uuid nullable

Optional subscription to deep-link to. Must belong to the same organization_consumer_id. Forwarded to the portal as a URL query param so the SPA can route directly to that subscription on load.

metered_subscription_idstring uuid nullable

Optional metered subscription to deep-link to. Must belong to the same organization_consumer_id. Forwarded to the portal as a URL query param so the SPA can route directly to that metered subscription on load.

Response

Successful Response

idstring
urlstring
created_atstring date-time
expires_atstring date-time

Changes