Skip to main content

Class wsRecurr

Properties​

NAMETYPELENGTHREQUIREDDESCRIPTION
CustomerNumberstring50YUnique identifier of the registered customer associated with this transaction.
AccountReferenceIDstring50YUnique identifier of the specific account associated with this transaction.
LocationIDintYUnique identifier generated by EPS for each location. (See - Required Data Elements)
Descriptionstring50This optional element can be used to define or explain the purpose of this transaction.
AmountdecimalYDollar amount of the transaction. This element cannot be (0) zero or negative.
TaxAmountdecimalNot used at this time. (See - Optional Data Elements)
ShippingAmountdecimalNot used at this time. (See - Optional Data Elements)
InvoiceNumberstring50A 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.
Frequencyenum of Type WSFrequencyValid 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)
PaymentDayshortYValid 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)
StartDateDateTimeYDate on which to begin taking payments.
NumPaymentsintYValid values are:
  • 1-100; 999 = Indefinite
PaymentsToDateintYThe number of payments already taken. Should be 0.
NotificationMethodenum of type WSNotificationMethodMethod 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.
NextPaymentDateDateTimeThe date the next recurring payment will take place. (See - Optional Data Elements)
Field1string50Optional information associated with a transaction. Data is stored with the transaction. Indexed field.
Field2string50Optional information associated with a transaction.
Field3string50Optional information associated with a transaction.
EnabledboolY0 = False; 1 = True
PaymentOriginenum of Type WSPaymentOriginIdentifies 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.
RecurringReferenceIDstring50Unique ID used to identify this specific recurring payment. (See - System Required/User Optional Data Elements)