EbizWebForm

Description

This object is used to create an ePayment form.

Properties

Type

Name

Description

string

FormType

  • EmailForm: for email payment forms
  • PmRequestForm: for Credit Card or ACH tokenization forms
  • WebForm: for Payment forms

(required)

string

FromEmail

From email address. (required)

string

FromName

From name. (required)

string

EmailAddress

Customer email address. (required)

string

CcEmailAddress

CC email addresses. (optional)

string

BccEmailAddress

BCC email addresses. (optional)

string

ReplyToEmailAddress

Reply to email addresses. (required)

string

ReplyToDisplayName

Reply to display name. (required)

string

EmailNotes

Email Notes. (optional)

string

EmailNotesHTML

Base64-encoded HTML notes. (optional)

string

EmailSubject

Email subject. (optional)

string

EmailTemplateID

Email template id to use when sending an email. (required)

string

EmailTemplateName

Email template to use when sending an email. (optional)

bool

SendEmailToCustomer

true or false. (required)

string

CustomerId

Customer ID. (required)

string

CustFullName

Customer's Full Name. (required)

string

TransId

Transaction ID. (required)

string

TransDetail

Transaction details. (required)

string

InvoiceNumber

Invoice number. (required)

string

PoNum

Purchase order number. (required)

string

SoNum

Sales order number. (required)

string

OrderId

Order ID. (required)

DateTime

Date

Invoice date. (required)

DateTime

DueDate

Invoice due date. (required)

decimal

TotalAmount

Total invoice amount. (required)

decimal

AmountDue

Amount due. (required)

decimal

TipAmount

Tip Amount. (optional)

decimal

ShippingAmount

Shipping Amount. (optional)

decimal

DutyAmount

Duty Amount. (optional)

decimal

TaxAmount

Tax Amount. (required)

string

Description

Description. (optional)

Address

BillingAddress

Billing Address. (required)

Address

ShippingAddress

Shipping Address. (optional)

string

ApprovedURL

Approved URL. (required)

string

DeclinedURL

Declined URL. (required)

string

ErrorURL

Error URL. (required)

int

DisplayDefaultResultPage

  • 1 yes
  • 0 No

(required)

string

PayByType

  • CC for credit card payments.
  • ACH for ACH payments.
  • EMV for EMV payments
  • Leave empty to allow credit card payments only
  • For combinations, use comma to separate them: CC,ACH

(required)

string

AllowedPaymentMethods

Visa, MasterCard, AmericanExpress, ACH

(required)

bool

SavePaymentMethod

True or false. (required)

bool

ShowSavedPaymentMethods

True or false. (required)

string

CountryCode

ISO-3166-1: Alpha-2 Codes
For example:
US United Stated
CA Canada

https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes

(required)

string

CurrencyCode

Currency code. (required)

string

ProcessingCommand

Processing command. Possible values: Sale, Credit, Void, CreditVoid, AuthOnly, Capture, PostAuth, Check, and CheckCredit. Default is Sale.

(optional)

string

SoftwareId

Software name (required)

string

TransactionLookupKey

A unique string that can be used to locate payments submitted using EBizWebForm

(required)

TransactionLineItem

LineItems

List of invoice items. (optional)

string

Clerk

(optional)

string

Terminal

(required)