Class WSRecurringTransaction
Properties
| NAME | TYPE | LENGTH | REQUIRED | DESCRIPTION |
|---|---|---|---|---|
| EntityId | int | Y | Unique identifier that is generated by EPS. (See - Required Data Elements) | |
| LocationId | int | Y | Unique identifier generated by EPS for each location. (See - Required Data Elements) | |
| RecurringPaymentOrigin | enum of Type WSRecurringPaymentOrigin | Y | Identifies by what method the transaction was originated. (See - Optional Data Elements) Valid values are:
*NOTE: Telephone transactions are not permitted if IsBusinessPayment = 1 (true). | |
| EffectiveDate | dateTime | Date 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) | ||
| Description | string | 50 | This optional element can be used to define or explain the purpose of this transaction. | |
| TotalAmount | decimal | Y | Dollar amount of the transaction. This element cannot be zero (0) or negative. | |
| BatchNumber | string | 40 | Supply 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. | |
| TransactionNumber | string | 50 | Y | Unique user-assigned identifier of the transaction being created. |
| Field1 | string | 50 | Optional information associated with the transaction. Data is stored with the transaction. Indexed field. | |
| Field2 | string | 50 | Optional information associated with the transaction. | |
| Field3 | string | 50 | Optional information associated with the transaction. | |
| RoutingNumber | string | 9 | Y* | *Bank Routing/Transit or ABA number. (See - PaymentOrigin Element Relationships) |
| AccountNumber | string | 17 | Y* | *This element represents the customer’s account number. Checking or Savings accounts: 4-17 digits. (See - PaymentOrigin Element Relationships) |
| CheckNumber | string | 17 | ||
| IsBusinessPayment | bool | Identifies the ACH only transaction as either drawn on a business or personal account. (See - Optional Data Elements) Valid values are:
| ||
| NameOnAccount | string | 50 | Y | Customer’s name as it appears on their account. This field is required for SettlementType ACH when PaymentOrigin is
|
| IpAddressOfOriginator | string | 15 | IP address of person sending request. May be automatically retrieved. | |
| FaceFeeType | enum of Type WSFaceFeeType | Valid values are:
| ||
| AccountType | enum of Type WSAccountType | Y* | Valid values are:
* Note: If Null, and the RoutingNumber element is supplied, the default value of "Savings" is used. | |
| bypassSmartDetect | bool | This is an optional element which will bypass the SmartDetect Service. Possible values are:
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. |