HppShippingAmountMode
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Discriminator for where a hosted payment page's shipping amount comes from.
Values
CardholderEntered |
The cardholder types the shipping amount into the shipping field (today's behaviour, and what a persisted null mode coalesces to). |
Flat |
The merchant fixed a single shipping amount for this page. The field renders visible, seeded with that amount, and non-editable, and the create path stamps the configured value server-side. An amount of zero is free shipping, which is a configured value like any other. |
ProviderCalculated |
The shipping amount comes from a carrier rate quote the cardholder selects. The page quotes the shipping address once it is complete, re-quotes whenever it changes, and preselects an option so a cardholder who ignores the selector still has a valid total. The submit carries only the quote and option identifiers; the create path re-reads the stored quote and charges its amount. What happens when no rate can be quoted is the page's shippingQuoteFailureBehavior. A session that locks a shipping amount wins over this mode, and the selector does not render for it at all. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.