Skip to main content

Class WSRecurringTransaction


Properties

NAMETYPELENGTHREQUIREDDESCRIPTION
EntityIdintYUnique identifier that is generated by EPS. (See - Required Data Elements)
LocationIdintYUnique identifier generated by EPS for each location. (See - Required Data Elements)
RecurringPaymentOriginenum of Type WSRecurringPaymentOriginYIdentifies by what method the transaction was originated. (See - Optional Data Elements)

Valid values are:
  • Internet
  • Signature_Faxed
  • Signature_Original
  • Telephone_IVR*
  • Telephone_Operator*
  • Corporate_Trade_Exchange
  • Can’t be null.


*NOTE: Telephone transactions are not permitted if IsBusinessPayment = 1 (true).
EffectiveDatedateTimeDate and time of the transaction. If null, the current date and time is assumed.

NOTE: This element does not require the Time to be included.

Identifies by what method the transaction was originated. (See - Optional Data Elements)
Descriptionstring50This optional element can be used to define or explain the purpose of this transaction.
TotalAmountdecimalYDollar amount of the transaction. This element cannot be zero (0) or negative.
BatchNumberstring40Supply only if a unique userassigned batch number was created using CreateProcessingBatch and the user wants to include this transaction in that batch. If not, leave blank or don’t include it in the request.
TransactionNumberstring50YUnique user-assigned identifier of the transaction being created.
Field1string50Optional information associated with the transaction. Data is stored with the transaction. Indexed field.
Field2string50Optional information associated with the transaction.
Field3string50Optional information associated with the transaction.
RoutingNumberstring9Y**Bank Routing/Transit or ABA number. (See - PaymentOrigin Element Relationships)
AccountNumberstring17Y**This element represents the customer’s account number. Checking or Savings accounts: 4-17 digits. (See - PaymentOrigin Element Relationships)
CheckNumberstring17
IsBusinessPaymentboolIdentifies the ACH only transaction as either drawn on a business or personal account. (See - Optional Data Elements)

Valid values are:
  • 1 (True) or 0 (False).
NameOnAccountstring50YCustomer’s name as it appears on their account. This field is required for SettlementType ACH when PaymentOrigin is
  • Internet (WEB),
  • Telephone_IVR,
  • Telephone_Operator,
  • Signature_Faxed,
  • Signature_Original
  • Corporate_Trade_Exchange
IpAddressOfOriginatorstring15IP address of person sending request. May be automatically retrieved.
FaceFeeTypeenum of Type WSFaceFeeTypeValid values are:
  • __None
  • Face
  • Bill_Convenience_Face
  • NSF_Fee
  • Bill_Convenience_Fee
  • If set to‘__None’ or Null, the default value ‘Face’ will be used. (See - Optional Data Elements)
AccountTypeenum of Type WSAccountTypeY*Valid values are:
  • Savings (Default)
  • Checking


* Note: If Null, and the RoutingNumber element is supplied, the default value of "Savings" is used.
bypassSmartDetectboolThis is an optional element which will bypass the SmartDetect Service.

Possible values are:
  • 0 = False; 1 = True and Null
  • Default to False


Note: This element cannot be empty or blank. If you are not using the SmartDetect service, you must provide a value of False or Null. If you are using the SmartDetect service but do not wish to bypass SmartDetect for a given transaction, you must also provide a value of False or Null.