View as Markdown

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:52 UTC.

`HppPanelDefinition`

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Describes the placement of a single panel on the Hosted Payment Page public form: which panel, in what order, and how wide on `md+` breakpoints.

Values

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields

Field Type Description

panelKey required

string

The panel this definition positions. Use a constant from `HppPanelKeys`. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sortOrder required

integer (int32)

Relative render order, ascending. Ties break on the order the definitions appear in the collection.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

columnSpan required

integer (int32)

Bootstrap 5 column span applied at the `md` breakpoint and up (1 to 12). On smaller viewports every panel is full width (`col-12`). Values outside 1 to 12 are clamped by the renderer.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This model has no documented fields.