Skip to main content

Class C21Transaction


Properties

NAMETYPELENGTHREQUIREDDESCRIPTION
EntityNameString120Custom name of the merchant.
EntityIdintUnique identifier that is generated by EPS.
LocationNameStringCustom name of a location.
PaymentOriginWSPaymentOriginPossible responses are:
  • Internet
  • Telephone_IVR
  • Telephone_Operator
  • Mailed_In
  • Drop_Box
  • Signature_Faxed
  • Signature_Original
  • Bounced_Check
  • Back_Office
  • Retail__POS
  • Represented_Check
  • Corporate_Trade_Exchange
AccountTypeWSAccountTypePossible responses 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
OperationTypeWSOperationTypePossible responses are:
  • Sale
  • Auth
  • Auth_Only
  • Credit
  • Refund
SettlementTypeWSSettlementTypePossible responses are:
  • ACH
  • Check_Image
  • Card_Transfer
  • None
TransactionStatusWSTransactionStatusPossible responses are:
  • Declined
  • Approved
  • Error
  • Voided
  • Processed
  • Collected
  • Awaiting_Capture
  • Awaiting_Approval
  • Suspended
  • In_Collection
  • In_Research
  • Disputed
  • Uncollected_NSF
  • Invalid__Closed_Account
  • Other_Check21_Returns
  • Resolved
SettlementStatusWSSettlementStatusPossible responses are:
  • No_Settlement_Needed
  • To_Be_Originated
  • Originating
  • Originated_Settlement_Pending
  • Settling
  • Settled
  • Charged_Back
EffectiveDateDateTimeDate of the transaction.
Descriptionstring50This optional element can be used to define or explain the purpose of this transaction.
TotalAmountdecimalDollar amount of the transaction.
TaxAmountdecimalNot used at this time. A value of ‘0’ will be returned.
ShippingAmountdecimalNot used at this time. A value of ‘0’ will be returned.
BatchNumberstring40Unique identifier of the batch associated with the transaction being requested.
TerminalNumberstring20
TransactionNumberstring50Unique identifier of the transaction being requested.
Field1string50Optional information associated with the transaction. Not returned in response if Not used at this time.
Field2string50Optional information associated with the transaction. Not returned in response if Not used at this time.
Field3string50Optional information associated with the transaction. Not returned in response if Not used at this time.
RoutingNumberstring9Zeroes will display for Credit Card transactions.
AccountNumberstring17Last 4 digits only displayed.
CheckNumberstring17
IsBusinessPaymentboolIdentifies the transaction as either a business or personal.

Possible responses are true or false.
NameOnAccountstring50Customer’s name as it appears on their card or account.
BillingAddress1string50Customer’s address, if available. Not returned in response if there is no other customer information available.
BillingAddress2string50Customer’s additional address information, if available. Not returned in response if there is no other customer information available.
BillingCitystring40City where the customer resides, if available. Not returned in response if there is no other customer information available.
BillingStateRegionstring40State in which the customer resides, if available. Not returned in response if there is no other customer information available.
BillingPostalCodestring10Zip code where the customer resides, if available. Not returned in response if there is no other customer information available.
BillingCountrystring40Country in which the customer resides, if available. Not returned in response if there is no other customer information available.
BillingPhonestring14Customer’s telephone number, if available. Not returned in response if there is no other customer information available.
EmailAddressstring60Customer’s email address, if available. Not returned in response if there is no other customer information available.
SSNstring15Customer’s Social Security Number, if available. Not returned in response if there is no other customer information available.
DLStatestring2State where the customer’s driver’s license is registered, if available. Not returned in response if there is no other customer information available.
DLNumberstring30Customer’s driver’s license number, if available. Not returned in response if there is no other customer information available.
NotificationMethodWSNotificationMethodPossible responses are:
  • Merchant_Notify
  • Merchant_Recording
  • Postcard
  • Email
FaceFeeTypeWSFaceFeeTypePossible responses are:
  • Face
  • Bill_Convenience_Face
  • Convenience_Fee
  • Bill_Convenience_Fee
  • NSF_Fee
  • None
CheckFrontImageBytes_TiffG4BinaryThis field will only be returned if this is a scanned check transaction and includeImages = True.
CheckRearImageBytes_TiffG4BinaryThis field will only be returned if this is a scanned check transaction and includeImages = True.
PresentmentNumberintA value of ‘0’ will be returned.
ReferenceNumberstring20Unique identifier generated by EPS for each transaction created.

WSPaymentOrigin

NAMETYPEDESCRIPTION
Internet0
Telephone_IVR1
Telephone_Operator2
Mailed_In3
Drop_Box4
Signature_Faxed5
Signature_Original6
Bounced_Check7
Back_Office8
Retail__POS9
__NONE10
Represented_Check11
Corporate_Trade_Exchange12

WSAccountType

NAMETYPEDESCRIPTION
Checking0
Savings1
Treasury_Check2
Money_Order3
Travelers_Check4
Convenience_Check5
Visa6
MasterCard7
Discover__Novus8
American_Express9
Diners__Carte_Blanche10
enRoute11
JCB12
Bank_Card13
Gift_Card14
On_Us_Card15
Payroll_Card16
Cashiers_Check17
__NONE18

WSOperationType

NAMETYPEDESCRIPTION
Sale0
Auth1
Auth_Only2
Credit3
__NONE4
Refund5
SDCredit6
SDSale7

WSSettlementType

NAMETYPEDESCRIPTION
ACH0
Check_Image1
Card_Transfer2
None3

WSTransactionStatus

NAMETYPEDESCRIPTION
Declined0
Approved1
Error2
Voided3
Processed4
Collected5
Awaiting_Capture6
Awaiting_Approval7
Suspended8
In_Collection9
In_Research10
Disputed11CC chargeback ACH R07 and R10
Uncollected_NSF12
Invalid__Closed_Account13ACH closed bad acct rtn...all admin returns
Other_Check21_Returns14
__NONE15
Resolved16
Unauthorized17

WSSettlementStatus

NAMETYPEDESCRIPTION
No_Settlement_Needed0
To_Be_Originated1
Originating2
Originated_Settlement_Pending3
Settling4
Settled5
Charged_Back6
__NONE7
Originated_SDACH8
Settled_SDACH9

WSNotificationMethod

NAMETYPEDESCRIPTION
Merchant_Notify0
Merchant_Recording1
Postcard2
Email3
Fax4

WSFaceFeeType

NAMETYPEDESCRIPTION
__None0
Face1
Bill_Convenience_Face2
Custom13
Custom24
Custom35
NSF_Fee6
Convenience_Fee7
Late_Fee8
Bill_Convenience_Fee131