HppSessionPurpose
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Classifies the calling context that produced an HPP session, which in turn drives the allowed TTL bounds and any other purpose-specific policy. The default is `CheckoutLink`, which is the historical merchant-facing pay-link behavior with a 1-minute to 15-minute TTL ceiling appropriate for hot checkout flows.
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.
CheckoutLink |
Standard merchant-facing pay-link session. Short TTL (60s to 900s). |
Invoice |
Session created by the invoicing module's send flow to back an invoice's pay-link. Long TTL (1h to 90d) so the link survives net-30 invoice terms with margin for late payment. |
PaymentMethodCapture |
Session created by the Merchant Billing module to back a stored-payment-method capture link emailed to a merchant. Long TTL (1h to 90d) so a link sent now can be completed days later, on the merchant's own time, rather than synchronously by an operator. |
Fields
| Field | Type | Description |
|---|
This model has no documented fields.