HostedPageReceipts
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Represents receipt and notification settings for the hosted payment page, including callback URLs, email options, and notification recipients.
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 |
|---|---|---|
callbackUrl
required |
string | Gets or sets an optional URL to receive a webhook notification when a hosted page transaction is processed.
Conditional: Conditional (see validator source). Max length: 200.
Conditional: When CallbackUrl is not empty.
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.
|
enableWebhookNotification
required |
boolean |
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.
|
enableCustomerEmail
required |
boolean |
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.
|
customerEmailLogo
required |
string | Gets or sets a logo to include on email receipts sent to the customer.
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.
|
customerEmailFooter
required |
string | Gets or sets optional footer text to include in customer email receipts.
nullablemax length 1000
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.
|
customerEmailBody
required |
string | Gets or sets optional body text for customer email receipts.
nullablemax length 3000
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.
|
useHostedConfirm
required |
boolean | Gets or sets a value indicating whether to use the hosted confirmation/receipt 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.
|
receiptAdditionalText
required |
string | Gets or sets optional additional text to include on receipts.
nullablemax length 1000
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.
|
customerEmailAsPdf
required |
boolean | Gets or sets a value indicating whether customer receipts are sent as PDF attachments.
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.
|
emailPurchaseNotifications
required |
boolean | Gets or sets a value indicating whether to notify email addresses of transactions completed via 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.
|
purchaseNotifyEmails
required |
array of HostedPagePurchaseNotificationEmail array of HostedPagePurchaseNotificationEmail | Gets or sets the list of email addresses to notify of completed purchases.
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.
|
Fields of each HostedPagePurchaseNotificationEmail: This body has no documented fields. | ||
This model has no documented fields.