View as Markdown

llms.txt

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.

API reference Models

HppHostChannel

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

Where the public hosted payment page delivers its lifecycle envelopes, and where it accepts commands from: the embedding browser window (the historical iframe integration), or a handler installed by a native app hosting the page in a WebView. This governs the transport only. The envelope vocabulary, the envelope shape, the payload members and the command names are identical on both channels.

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.
ParentWindow The default, historical behavior: envelopes are posted to window.parent with the session's parent origin as the target origin, and inbound commands arrive as window messages from that same origin. Emission fails closed when the session carries no parent origin. null (legacy sessions) resolves here.
NativeWebView The page is a top-level document inside a native app's WebView, so it has no parent window and no parent origin. Envelopes are delivered to the single message handler the host app installed under the protocol's handler name, and commands arrive through the protocol's entry-point function the host app calls. The host app is the trust boundary: there is no origin to validate, and the embedding-domain allow-list does not apply.

Fields

Field Type Description

This model has no documented fields.

Reconnecting to the server

Could not reconnect

This session has ended

Attempt 1

Your work on this page is still here. Retrying keeps it; reloading starts the page again.

The server no longer holds this page's state, so it has to be loaded again.