Class SetupRecurringPaymentRequest

---

Properties

NAME	TYPE	LENGTH	REQUIRED	DESCRIPTION
storeId	long		Y	Unique user ID generated by EPS. (See - Required Data Elements)
storeKey	string		Y	Unique password generated by EPS. (See - Required Data Elements)
entityId	int		Y	Unique identifier that is generated by EPS. (See - Required Data Elements)
wsRecurr	wsRecurr

wsRecurr

NAME	TYPE	LENGTH	REQUIRED	DESCRIPTION
CustomerNumber	string	50	Y	Unique identifier of the registered customer associated with this transaction.
AccountReferenceID	string	50	Y	Unique identifier of the specific account associated with this transaction.
LocationID	int		Y	Unique identifier generated by EPS for each location. (See - Required Data Elements)
Description	string	50		This optional element can be used to define or explain the purpose of this transaction.
Amount	decimal		Y	Dollar amount of the transaction. This element cannot be (0) zero or negative.
TaxAmount	decimal			Not used at this time. (See - Optional Data Elements)
ShippingAmount	decimal			Not used at this time. (See - Optional Data Elements)
InvoiceNumber	string	50		A unique value assigned by the user, which, when combined with the PaymentsToDate value and a system generated recurring ID makes up the TransactionNumber for this transaction. Can’t be null.
Frequency	enum of Type WSFrequency			Valid values are: Once_a_Month Twice_a_Month Once_a_Week Every_2_Weeks Once_a_Quarter Twice_a_Year Once_a_Year If null, the default value of Once_a_Month will be used. (See - Optional Data Elements)
PaymentDay	short		Y	Valid values are: Once_a_Month (1 – 31; 32 = Last Day) Once_a_Quarter (same as above) Twice_a_Year (same as above) Once_a_Year (same as above) Twice_a_Month (1=1st & 15th or 2=15th & Last) Once_a_Week (0=Sun; 1=Mon; 2=Tue; 3=Wed; 4=Thu; 5=Fri; 6=Sat) Every_2_Weeks (0= Sun; 1= Mon; 2= Tue; 3=Wed; 4=Thu; 5=Fri; 6=Sat)
StartDate	DateTime		Y	Date on which to begin taking payments.
NumPayments	int		Y	Valid values are: 1-100; 999 = Indefinite
PaymentsToDate	int		Y	The number of payments already taken. Should be 0.
NotificationMethod	enum of type WSNotificationMethod			Method by which a merchants’s customer will be notified of an ACH or credit card transaction. (See - Optional Data Elements) Valid values are: Merchant_Notify Merchant_Recording Postcard Email If null, the default value of Merchant_Notify is assumed.
NextPaymentDate	DateTime			The date the next recurring payment will take place. (See - Optional Data Elements)
Field1	string	50		Optional information associated with a transaction. Data is stored with the transaction. Indexed field.
Field2	string	50		Optional information associated with a transaction.
Field3	string	50		Optional information associated with a transaction.
Enabled	bool		Y	0 = False; 1 = True
PaymentOrigin	enum of Type WSPaymentOrigin			Identifies by what method the transaction was originated. (See - Optional Data Elements) Valid values are: Internet Signature_Faxed Signature_Original Telephone_IVR* Telephone_Operator* *Telephone transactions can’t be created for a business customer. If null, the default value of Internet is assumed.
RecurringReferenceID	string	50		Unique ID used to identify this specific recurring payment. (See - System Required/User Optional Data Elements)
companyEntryDescription	string	10		Requested ACH Company Entry Description to use for the transaction in the ACH Batch Header. Note: Provided ACH Company Entry Description value may be overwritten with a system value where required.