API Reference

Get Hosted User Experience Configuration

post
https://example.com/programs//hosted/ux

Retrieves a PCI widget configuration and a hosted user experience URL for the specified activity and program. Validates the activity, finds the product code, and returns a secure URL for embedding in client applications.

Path Params
string
required

The program code identifying the hosted user experience context.

Body Params

The request payload containing the activity name, success and error URLs, and optional activity data. See Gd.Bos.DataTransfer.Request.GetConfigurationRequest for details.

string | null

The name or type of the activity for which configuration is being requested (e.g., "enrollment", "payment").

activityData
object | null

A dictionary of key-value pairs providing additional data or context for the activity.

string | null

The URL to redirect to or call upon successful completion of the activity.

string | null

The URL to redirect to or call if an error occurs during the activity.

Headers
string
required

A unique request identifier for tracking and logging.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Updated 2 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
text/json

Updated 2 months ago