Catalyst Fire Ignition Documentation
CheckoutOptions Class
Represents possible options that can be used to customize the checkout process
Definition
Namespace: Ignition.Commerce.Shopping
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public class CheckoutOptionsVB
Public Class CheckoutOptionsC++
public ref class CheckoutOptionsF#
type CheckoutOptions = class end- Inheritance
- Object CheckoutOptions
Constructors
| CheckoutOptions | Initializes a new instance of the CheckoutOptions class |
Properties
| BillingBehavior | How NetFORUM should go about billing the customer for their purchase |
| ConfirmationEmailBccAddresses |
A comma or semicolon-delimited list of email addresses that will be BCC'ed on the NetFORUM confirmation email, if one is sent.
Note that this will replace any BCC addresses already defined on the correspondence template.
Obsolete. |
| ConfirmationEmailOverrides | Settings to override default behaviors surrounding to netFORUM's checkout confirmation email |
| CustomBatchId | The Id of a specific pre-existing batch to use for this transaction. |
| CustomBatchName | A "base" batch name for this transaction, which netFORUM will modify with prefixes and suffixed. If no value is provided, NetFORUM will determine the value to use (typically "WEB"). If a value is provided, but the payment method used for checkout has an apm_suffix defined, netFORUM will use that instead. |
| ExternalNotes | External notes to be added to the order or invoice created as a result of the checkout process |
| InstallmentSchedule | The billing or payment schedule, used only when BillingBehavior is of a type that involves a schedule; otherwise, should be left null. |
| InternalNotes | Internal notes to be added to the order or invoice created as a result of the checkout process |
| OverpaymentBehavior | Determines how to handle payments that are greater than the total cost of the shopping cart |
| PurchaseOrderNumber | A purchase order number to be associated with this transaction |
| SaveCreditCard | Determines if NetFORUM should save the credit card used in this checkout for future use |
| SkipShippingMethodValidation | Skips checks to validate that the cart's shipping method is set (or not set) correctly. |
| SuppressConfirmationEmail | Suppresses the confirmation email that NetFORUM normally sends the purchasing user after checkout completes |
| UnderpaymentBehavior | Determines how to handle payments that are less than the total cost of the shopping cart |