|
Input Fields
|
Required
|
Character Limits/Required Input
|
Description
|
|
storeId
|
Yes
|
num
|
A unique user ID systematically generated by EPS upon installing a web service user. The storeId can be unique to each individual merchant, or a master storeId can be assigned at the partner/owner level.
|
|
storeKey
|
Yes
|
char
|
A unique password systematically generated by EPS upon installing a web service user. The password corresponds with the storeId above.
|
|
EntityId
|
Yes
|
num
|
The entityId is a unique identifier that is systematically generated when the merchant is installed on the EPS system. It is also referred to as the Merchant ID or MID.
|
|
LocationId
|
Yes
|
num
|
The locationId is a unique identifier for each location (account) set up under a user. Users that process transactions for multiple accounts, or use the same account for multiple purposes (i.e. building fund, donations, dues), will be assigned individual location IDs for each.
|
|
PaymentOrigin
|
Yes
|
char
|
This element identifies by what method the transaction was originated. If this element is not included in the request then the default value of ‘Internet’ is assumed.
|
|
AccountType
|
Yes
|
char
|
Valid values are:
Checking
Savings
Treasury_Check
Money_Order
Travelers_Check
Convenience_Check
Visa
MasterCard
Discover__Novus
American_Express
Diners__Carte_Blanche
enRoute
JCB
Bank_Card
Gift_Card
On_Us_Card
Payroll_Card
Cashiers_Check
__None
|
|
OperationType
|
Yes
|
char
|
This element identifies the transaction as either a debit or credit (including Same
Day ACH debits or credits). If null, the default value of ‘Sale’ will be assumed.
|
|
SettlementType
|
Yes
|
char
|
This element identifies the transaction type. i.e. ACH, Check_Image etc. If null, the default value of ‘ACH’ will be assumed.
|
|
EffectiveDate
|
No
|
DateTime
|
This element identifies the date and time the transaction will be, or was, processed. If null, the current date and time will be assumed. If a date is provided without a specific time, then the exact time the transaction is processed will be applied.
|
|
Description
|
No
|
50 char
|
This optional element can be used to define or explain the purpose of this transaction.
|
|
TotalAmount
|
Yes
|
Decimal
|
Dollar amount of the
transaction. This element cannot be zero (0) or negative.
|
|
Sale
|
No
|
char
|
Not used
|
|
ConvenienceFeeAmount
|
No
|
char
|
Applicable to Credit Card transactions only. Fee added to the face value of the transaction.
|
|
TransactionNumber
|
Yes
|
50 char
|
Unique user-assigned identifier of the transaction being created.
|
|
Field1
|
No
|
50 char
|
Optional information associated with the transaction. Data is stored with the transaction. Indexed field.
|
|
Field2
|
No
|
50 char
|
Optional information associated with the transaction. Data is stored with the transaction. Indexed field.
|
|
Field3
|
No
|
50 char
|
Optional information associated with the transaction. Data is stored with the transaction. Indexed field.
|
|
CheckMICRLine
|
No
|
char
|
Scanned MICR line of the check. Required for check transactions only.
|
|
CheckMICRSymbolSet
|
No
|
char
|
Identifies the symbol set used by the scanner (e.g. “TOAD ?”). Required for check transactions only.
|
|
RoutingNumber
|
No
|
9 char
|
Bank Routing/Transit or ABA number. Required for check transactions only.
|
|
AccountNumber
|
No
|
17 char
|
This element represents the customer’s account number. Checking or Savings accounts: 4-17 digits; Credit Card accounts:16 digits or less.
|
|
CheckNumber
|
No
|
17 char
|
Required if the ACH Transaction PaymentOrigin is Bounced_Check or Represented_Check.
|
|
SwipeTrack1
|
No
|
char
|
Credit Card only. Track 1 for device used for card swipe.
|
|
SwipeTrack2
|
No
|
char
|
Credit Card only. Track 2 for device used for card swipe.
|
|
SwipeTrack3
|
No
|
char
|
Credit Card only. Track 3 for device used for card swipe.
|
|
IsBusinessPayment
|
Yes
|
bool (1 or 0)
|
Identifies the ACH only transaction as either drawn on a business or personal account.
Valid values are:
1 (True) or 0 (False).
|
|
NameOnAccount
|
Yes
|
50 char
|
Customer’s name as it appears on their card or account.
|
|
BillingAddress1
|
No
|
50 char
|
Street address associated with this account.
|
|
BillingAddress2
|
No
|
50 char
|
Additional street address information associated with this account
|
|
BillingCity
|
No
|
40 char
|
City associated with this account.
|
|
BillingStateRegion
|
No
|
40 char
|
State/Region associated with this account.
|
|
BillingPostalCode
|
No
|
10 char
|
Zip/Postal Code associated with this account.
|
|
BillingCountry
|
No
|
40 char
|
Country associated with this account.
|
|
BillingPhone
|
No
|
14 num
|
Telephone number associated with this account, if available.
|
|
EmailAddress
|
No
|
60 char
|
Email address associated with this account, if available.
|
|
SSN
|
No
|
15 char
|
Social Security Number associated with this account, if available.
|
|
DLState
|
No
|
2 char
|
State where the driver’s license associated with this account is registered, if available.
|
|
DLNumber
|
No
|
30 char
|
Driver’s license number associated with this account, if available.
|
