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:57 UTC.

API reference Models

HostedPaymentPageActionUrls

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

Represents the set of action URLs for the hosted payment page, including submit, edit, continue, and cancel (Back) actions.

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
submit required URLConfig URLConfig Gets or sets the URL to use when the payment is submitted.
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 of URLConfig:

Field Type Description
url required string The destination URL that the hosted payment page should navigate to when the associated action is triggered. 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.
enabled required boolean Indicates whether this action URL is enabled and should be used by the hosted payment page. If false, the action will not be available.
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.
label required string Optional UI label describing the action. This can be used to display user-friendly text such as "Edit Transaction" or "Continue". 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.

This body has no documented fields.

edit required URLConfig URLConfig Gets or sets the URL to use on the hosted receipt page to return to the transaction page.
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 of URLConfig:

Field Type Description
url required string The destination URL that the hosted payment page should navigate to when the associated action is triggered. 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.
enabled required boolean Indicates whether this action URL is enabled and should be used by the hosted payment page. If false, the action will not be available.
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.
label required string Optional UI label describing the action. This can be used to display user-friendly text such as "Edit Transaction" or "Continue". 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.

This body has no documented fields.

continue required URLConfig URLConfig Gets or sets the URL to use on the hosted receipt page to navigate to a different page.
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 of URLConfig:

Field Type Description
url required string The destination URL that the hosted payment page should navigate to when the associated action is triggered. 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.
enabled required boolean Indicates whether this action URL is enabled and should be used by the hosted payment page. If false, the action will not be available.
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.
label required string Optional UI label describing the action. This can be used to display user-friendly text such as "Edit Transaction" or "Continue". 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.

This body has no documented fields.

cancel required URLConfig URLConfig Gets or sets the address the payer's Back link returns to from the payment form, before paying (typically the merchant's cart). A session-level `cancelUrl` overrides it.
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 of URLConfig:

Field Type Description
url required string The destination URL that the hosted payment page should navigate to when the associated action is triggered. 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.
enabled required boolean Indicates whether this action URL is enabled and should be used by the hosted payment page. If false, the action will not be available.
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.
label required string Optional UI label describing the action. This can be used to display user-friendly text such as "Edit Transaction" or "Continue". 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.

This body has no documented fields.

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.