EbizWebForm

Description

The EbizWebForm object represents an EBizCharge ePayment Form and contains all related information. The fields displayed are dependent on the method being used.

Properties

Type	Name	Description
string	FormType	The type of form to generate. Email templates are customizable in the EBizCharge Admin Portal. Default: `Webform` Possible Values `Webform` - Generates a link to a dynamic webform that can be imbedded in a webpage for payment. `PmRequestForm` (Request Payment Method) - Sends an email prompting the user to add/tokenize a payment method. `EmailForm` (Email Payment Request) - Sends an email to the user requesting payment. `CheckoutGuest` - Used for a minimal guest checkout form. `CheckoutUser` - Used for a minimal user checkout form. `RPMCheckoutGuest` - Used for a minimal guest checkout tokenization form. `RPMCheckoutUser` - Used for a minimal user checkout tokenization form. `MerchantForm` - Used internally by merchants. CVV is not required for payment processing. `PayLinkOnly` - Used within ERPs.
string	FromEmail	Email address displayed in the email's "From" field.
string	FromName	Name displayed in the email's "From" field.
string	EmailAddress	Customer email address.
string	CcEmailAddress	Email address(es) to include as CC recipients.
string	BccEmailAddress	Email address(es) to include as BCC recipients.
string	ReplyToEmailAddress	Email address to send customer replies to.
string	ReplyToDisplayName	Display name for the `ReplyToEmailAddress`.
string	EmailNotes	Custom note included in the body of the email.
string	EmailNotesHTML	Base64-encoded HTML content included in the body of the email.
string	EmailSubject	Subject line of the email.
string	EmailTemplateID	Identifies which EmailTemplate to use by ID.
string	EmailTemplateName	Identifies which EmailTemplate to use by name.
bool	SendEmailToCustomer	Indicates whether an email should be sent to the customer.
string	CustomerId	Identifies the associated Customer object.
string	CustFullName	Full name of the customer.
string	TransId	Unique identifier for the transaction.
string	TransDetail	Transaction details.
string	InvoiceNumber	Identifies the associated Invoice object.
string	PoNum	Purchase order number.
string	SoNum	Sales order number.
string	OrderId	Unique identifier for the transaction, with a maximum length of 64 characters. Note: Required for Level 2 and Level 3.
DateTime	Date	Date and time the webform is created.
DateTime	DueDate	Date and time when the `AmountDue` value is due.
decimal	TotalAmount	Total amount of the invoice.
decimal	AmountDue	Amount of the invoice due by the `DueDate`.
decimal	TipAmount	Amount added as a tip.
decimal	ShippingAmount	Amount charged for shipping.
decimal	DutyAmount	Amount charged for duty.
decimal	TaxAmount	Amount charged for tax.
string	Description	Description shown on the invoice.
BillingAddress	BillingAddress	Billing address for the customer.
ShippingAddress	ShippingAddress	Shipping address for the customer.
string	ApprovedURL	URL to redirect to when a payment is approved.
string	DeclinedURL	URL to redirect to when a payment is declined.
string	ErrorURL	URL to redirect to when an error occurs during payment.
int	DisplayDefaultResultPage	Specifies whether to display the EBizCharge result page or a custom page. Possible Values `1` to display the EBizCharge result page `0` to display a user defined result page (store URL in `ApprovalURL`)
string	PayByType	Specifies allowed payment types, separated by commas. Possible Values `CC` for credit card `ACH` for ACH `EMV` for EMV Leave empty to only allow credit cards
string	AllowedPaymentMethods	Specifies allowed payment methods. Possible Values `Visa` `MasterCard` `AmericanExpress` `ACH` `Discover`
bool	SavePaymentMethod	Indicates whether to save the customer's payment method.
bool	ShowSavedPaymentMethods	Indicates whether to allow the customer to view their saved payment methods.
string	CountryCode	Two-character ISO 3166-1 country code. Examples `US` for United States `CA` for Canada
string	CurrencyCode	Three-character ISO 4217 currency code.
string	ProcessingCommand	Specifies the type of transaction command to process. Default: `Sale`. Possible Values `Sale` - Used for Straight Sale. `AuthOnly` - Used for Pre-Authorization.
string	SoftwareId	Unique identifier for the associated software.
string	TransactionLookupKey	Unique key for locating transactions submitted using EBizWebForm.
TransactionLineItem	LineItems	List of items included in the transaction.
string	Clerk	Person responsible for processing the transaction.
string	Terminal	Terminal used for the transaction.
bool	ShowViewInvoiceLink	Indicates whether to include a link to the associated Invoice object in the email body and web form page.
string	InvoiceInternalId	Identifies the associated Invoice object.
DeviceSettings	DeviceSettings	Specifies the device settings.
string	DocumentTypeId	Identifies the associated PaidDocument object.
bool	ShowViewSalesOrderLink	Indicates whether to include a link to the associated SalesOrder object in the email body and web form page.
string	SalesOrderInternalId	Identifies the associated SalesOrder object.