GRgreendot
HostedUserExperience

Get Hosted User Experience Configuration

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.

post/programs/{programCode}/hosted/ux

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

programCodestring required

The program code identifying the hosted user experience context.

Headers

X-GD-RequestIdstring required

A unique request identifier for tracking and logging.

Request body

activitystring nullable

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

activityDataobject nullable

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

successUrlstring nullable

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

errorUrlstring nullable

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

Response

OK

urlstring nullable

The configuration or redirection URL returned by the operation.

Changes

No recorded changes to this operation across all 2 revisions of this API.