SendHppSessionLinkInput
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Input DTO for sending an HPP session payment link to a recipient.
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 | ||||
|---|---|---|---|---|---|---|
sessionId
required |
string (uuid) | The session ID whose payment link should be sent.
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.
| ||||
deliveryMethod
required |
HppLinkDeliveryMethod HppLinkDeliveryMethod | How to deliver the payment link.
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.
| ||||
recipientAddress
required |
string | The recipient address (email address or phone number, depending on delivery method).
Required: When DeliveryMethod == Email.
Required: When DeliveryMethod == Sms.
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) | Optional customer ID for audit/tracking purposes.
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.