HppSessionAmountMode
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
How a hosted payment page session treats the payment amount the cardholder sees. Orthogonal to the page's own amount configuration: when a session declares a mode other than `CustomerEntered`, it overrides whether the page would otherwise let the customer set the amount. The amount value itself continues to ride the session's prefilled `base_amount` field.
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.
CustomerEntered |
The default, historical behavior: the session specifies no amount and the cardholder types it on the page. null (legacy sessions) resolves here. |
Suggested |
The session specifies an amount (via the prefilled base_amount) that pre-fills the page, but the cardholder may edit it (e.g. a suggested donation). |
Locked |
The session specifies an amount (via the prefilled base_amount) that the cardholder cannot change (e.g. paying an invoice). The amount renders read-only but visible, and the server verifies on submit that the charged base amount matches the session's specified amount. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.