HppSessionEffectiveShapeDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
The shape the server actually resolved a hosted-payment-page session into, echoed on the session-create response so an integrator can confirm what was persisted without loading the hosted page and inspecting it.
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 | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
consentRequired
required |
boolean | Whether the cardholder <b>must</b> tick the stored-credential consent box before the payment
can be 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.
| ||||||||||
consentPromptShown
required |
boolean | Whether the public page renders the stored-credential consent prompt for this session, i.e.
whether the session declared any credential-storage intent. When `false`, consent plays
no part in the flow and `consentRequired` is `false`.
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.
| ||||||||||
requestedCredentialStorage
required |
StoredCredentialUsage StoredCredentialUsage | The stored-credential usage scopes the cardholder is being asked to consent to, after
server-side defaulting and purpose forcing: a tokenizing session that declared no scope
resolves to `UnscheduledCOF`, and a Save Card with Initial
Charge session always has `Recurring` unioned in on top of
whatever the request asked for. `null` means no credential storage was requested. 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.
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.
| ||||||||||
pagePurpose
required |
HppPagePurpose HppPagePurpose | The page purpose this session actually runs, after applying the request's optional
`pagePurpose` override over the targeted page's own configured purpose. A page with no
configured purpose resolves to `Payment`.
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.
| ||||||||||
tokenizeOnPayment
required |
boolean | Whether the cardholder's payment method will be vaulted as a reusable token. This is the
effective decision after the merchant's tokenize-by-default setting is applied and after the
targeted page's tokenization toggle (`SupportTokenization` / `SavePaymentDetails`)
has had its say. A request that asked for `tokenizeOnPayment: true` against a page whose
merchant disabled tokenization reports `false` here: that is the veto, which previously
only appeared in a server-side log line. Always `true` for a card-capture purpose, which
exists to store the credential.
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.
| ||||||||||
saveCardOnly
required |
boolean | Whether this session stores the payment method with no charge at all. `true` for a
resolved `SaveCard` purpose or an explicit `saveCardOnly`
request on a Payment page. Deliberately `false` for
`SaveCardWithInitialCharge`, which takes a real initial charge, so
a request that sent `saveCardOnly: true` against that purpose reports `false` here.
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.
| ||||||||||
captureMode
required |
HppCaptureMode HppCaptureMode | Capture timing for the chargeable Payment flow: `Sale` authorizes
and captures in one step, `Authorize` authorizes now for a later
capture. Resolved from the request's optional override over the page's configured value.
Reported as `Sale` for a card-capture purpose, where capture
timing is not an axis: those purposes set their own transaction shape.
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.
| ||||||||||
amountMode
required |
HppSessionAmountMode HppSessionAmountMode | How the cardholder may set the amount. `CustomerEntered`
leaves the page's own amount behaviour in charge; `Suggested`
pre-fills an editable amount; `Locked` pre-fills a read-only
amount that the server verifies on submit.
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.
| ||||||||||
taxAmountMode
required |
HppSessionAmountMode HppSessionAmountMode | The mode the tax line runs under. This is the resolved value: a request that omitted
`taxAmountMode` reports the effective `amountMode` here, because that is what
the tax follows. `Locked` means the server charges the
session's `tax` prefill whatever the payer submits.
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.
| ||||||||||
shippingAmountMode
required |
HppSessionAmountMode HppSessionAmountMode | The mode the shipping amount runs under, resolved the same way as `taxAmountMode`.
`Locked` means the server charges the session's
`shipping` prefill, ahead of any flat shipping rate the page configures.
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.
| ||||||||||
lockShippingAddress
required |
boolean | Whether this session shows its prefilled shipping address display-only and records that
address on the transaction whatever the payer submits.
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.
| ||||||||||
customerEmailVisibility
required |
HppFieldVisibility HppFieldVisibility | The per-session visibility of the payer-facing customer-email field, as it was accepted and
stored. `null` means the session did not override it and the page's own
`FieldCustomerEmail` applies.
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.
| ||||||||||
declineRetryMode
required |
HppDeclineRetryMode HppDeclineRetryMode | What this session does with its payment link when a payment is declined, as resolved from
the per-session override, the hosted page and the tenant default when the session was
created.
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.
| ||||||||||
linkLifetime
required |
HppLinkLifetime HppLinkLifetime | The link lifetime the session was actually minted with, read off the created session rather
than off the request. `Session` is what a request that named no
lifetime resolves to.
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.
| ||||||||||
remainingDeclineReleases
required |
integer (int32) | How many further times this link may be reopened after a declined payment. Always zero when
`declineRetryMode` is `ConsumeOnDecline`, and it
counts down as a payer spends attempts.
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.
| ||||||||||
currency
required |
string | The ISO 4217 currency this session is denominated in, upper-cased. A request that named one
gets it back verbatim, having been checked against the merchant's configured currency; a
request that named none gets the merchant's currency, which is the defaulting this block
exists to report. `null` only when the merchant has no currency configured at all, which
is the state every session predating this field is in.
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.
| ||||||||||
customerId
required |
string (uuid) | The customer this session is bound to, echoed from the request's `customerId` after it
was validated to exist, be active, and belong to the page's merchant. `null` for an
unbound session, where the cardholder's email is the only customer-resolution anchor.
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.
| ||||||||||
prefilledFieldKeys
required |
array of string array of | The prefilled field keys stored on the session, in no particular order. Values are never
echoed. Compare against what was sent to confirm every key was accepted, and note that the
server may add one: deriving a locked amount from a fixed-amount page stamps
`base_amount` even when the request supplied none.
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.
| ||||||||||
ignoredPrefillKeys
required |
array of string array of | The subset of `prefilledFieldKeys` that the hosted page will silently ignore
when it renders: keys that are neither a well-known field nor an enabled, page-visible
merchant custom field. They are accepted and persisted rather than rejected, for backward
compatibility, so this list is the only signal that a key will have no effect (usually a
typo, or a custom field that is disabled or hidden for hosted pages).
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 model has no documented fields.