id
required |
string (uuid)
|
The completion's own identifier, which is also the session id this payer's surfaces and their
resulting transaction were keyed on.
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.
|
parentSessionId
required |
string (uuid)
|
The reusable session this visit belongs 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.
|
hostedPageId
required |
string (uuid)
|
The hosted payment page the link targets.
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.
|
merchantId
required |
string (uuid)
|
The merchant that owns the hosted payment 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.
|
shortToken
required |
string
|
The short URL token of the link this payer arrived through.
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.
|
status
required |
HppSessionStatus
HppSessionStatus |
The visit's persisted status.
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.
Pending |
The session has been created and is awaiting use by a customer. Also the status a session returns to when a premature consume is released: a submission that was rejected by pure request-shape validation before the orchestrator was invoked leaves the link usable, so the payer can correct their input and resubmit on the same link (see Consumed). | Consumed |
The session has been consumed by a transaction submission. Terminal in practice: the only exit is the narrow release back to Pending performed by HppSession.ReleaseConsume, which requires that the session carries no OrchestratorDispatchedAt marker, that the consuming transaction id is still the one recorded, and that no vault token was minted. Once a submission reaches the orchestrator the marker is durable and the session stays Consumed regardless of the outcome, including a decline. Submit paths additionally validate the request BEFORE consuming, so a rejected request usually never spends the link in the first place; the release covers the rules that can only run inside the create. | Revoked |
The session has been manually revoked by an administrator. | Cancelled |
The session was cancelled by the parent page via the iframe two-way command channel Distinct from Revoked (admin-initiated) for clarity in audit + reporting: same terminal effect (session can no longer be consumed). | Completed |
A reusable link has taken every completion it was capped at, so it accepts no further payers. Terminal, and reachable only on a reusable session: a single-use link spends itself through Consumed instead, and a reusable one is never Consumed because its per-payer consume state lives on its HppSessionCompletion children rather than on the parent. A reusable link created with no cap never reaches this status; it stays payable until it is revoked, cancelled or expires. |
|
derivedState
required |
HppSessionDerivedState
HppSessionDerivedState |
The state a reader should see for this visit: the stored status when it is terminal,
otherwise usable or expired by the clock.
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.
Usable |
Pending and not yet past its expiry instant: the link can still be presented and consumed. | Expired |
Pending, but the expiry instant has passed. The document may still be readable for the retention window configured by HostedPaymentPageSettings.SessionExpiredRetentionDays, which is what lets a payer see a distinct expired page and an administrator see the row on a grid. | Consumed |
Consumed by a transaction submission (Consumed). | Revoked |
Revoked by an administrator (Revoked). | Cancelled |
Cancelled by the parent page over the iframe command channel (Cancelled). | Completed |
A reusable link that has taken its last capped completion (Completed). The reusable analogue of Consumed: the link is spent, but by many payers rather than one. | Paused |
The merchant has paused the link. Unlike every other non-usable state this one is reversible: a resume puts the link straight back to Usable with its expiry, cap and prefill untouched. A payer who opens a paused link sees the merchant's own inactive message rather than the generic out-of-service copy. |
|
createdAt
required |
string (date-time)
|
When this visit was minted, in UTC.
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.
|
expiresAt
required |
string (date-time)
|
When the link expires, in UTC, or `null` for a link that does not expire.
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.
|
consumedByTransactionId
required |
string (uuid)
|
The transaction that completed this visit, or `null`.
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.
|
consumedAt
required |
string (date-time)
|
When this visit was consumed, in UTC, or `null`.
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.
|
vaultedPaymentTokenId
required |
string (uuid)
|
The vault token minted for this payer by a direct-vault reservation, or `null`.
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 |
The decline-retry policy this visit inherited from the link.
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.
ConsumeOnDecline |
The historical behavior, and the default at every level of the resolution chain. Any processor answer spends the link permanently: the session stays Consumed and a payer who reloads it is told the link has already been used. | ReleaseOnDecline |
A definite issuer decline hands the link back to Pending so the payer can correct their card and resubmit on the same URL, instead of having to ask the merchant for a new link. |
|
declineReleaseCount
required |
integer (int32)
|
How many decline releases this payer has spent, or `null` for 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.
|
lastDeclinedTransactionId
required |
string (uuid)
|
The transaction whose decline last reopened this visit, or `null`.
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.
|
lastDeclineReleasedAt
required |
string (date-time)
|
When this visit was last reopened after a decline, in UTC, or `null`.
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.
|
consumedOrder
required |
HppCatalogOrder
HppCatalogOrder |
The catalog order this payer bought, resolved and priced by the platform when they paid, or
`null` until then (and always on a link off a page that sells no products).
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.
|