Skip to main content

Class GetRecurringForCustomerResponse


Properties

NAMETYPELENGTHDESCRIPTION
CustomerNumberstring50Unique identifier of the registered customer being requested.
AccountReferenceIDstring50Unique identifier of the specific account.
LocationIDintUnique identifier generated by EPS for each location.
Descriptionstring50This optional element can be used to define or explain the purpose of this transaction.
AmountdecimalDollar amount of the transaction.
TaxAmountdecimalNot used at this time.
ShippingAmountdecimalNot used at this time.
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.
Frequencyenum of Type WSFrequencyPossible responses are:
  • Once_a_Month
  • Twice_a_Month
  • Once_a_Week
  • Every_2_Weeks
  • Once_a_Quarter
  • Twice_a_Year
  • Once_a_Year
PaymentDayshortFor: Possible responses 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
StartDateDateTimeDate on which to begin taking payments.
NumPaymentsintValid values are:
  • 1-100; 999 = Indefinite
PaymentsToDateintThe number of payments already taken.
NotificationMethodenum of Type WSNotificationMethodPossible responses are:
  • Merchant_Notify
  • Merchant_Recording
  • Postcard
  • Email
NextPaymentDateDateTimeThe date the next recurring payment will take place.
Field1stringOptional information associated with the transaction.
Field2stringOptional information associated with the transaction.
Field3stringOptional information associated with the transaction.
Enabledbool0 = False; 1 = True
PaymentOriginenum of Type WSPaymentOriginValid values are
  • Internet
  • Signature_Faxed
  • Signature_Original
  • Telephone_IVR
  • Telephone_Operator
  • Credit_Send
  • Request_for_Payment
  • Return_Request
RecurringReferenceIDstring50Used to identify the specific recurring payment being requested.
companyEntryDescriptionstring10Actual ACH Company Entry Description assigned to the transaction for use in the ACH Batch Header (Record 5, Field 7).

Note: Requested ACH Company Entry Description may be overwritten with a system value where required.