Skip to main content

Class GetTransactionByTransactionNumber2Response


Properties

NAMETYPELENGTHDESCRIPTION
EntityIdintUnique identifier that is generated by EPS.
LocationIdintUnique identifier generated by EPS for each location.
PaymentOriginenum of Type WSPaymentOriginPossible 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
  • Credit_Send
  • Request_for_Payment
  • Return_Request
AccountTypeenum of Type WSAccountTypePossible 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
  • FedNow
  • Virtual Card
  • __None
OperationTypeenum of Type WSOperationTypePossible responses are:
SettlementTypeenum of Type WSSettlementTypePossible responses are:
  • ACH
  • Check_Image
  • Card_Transfer
  • Instant_Payments
  • None
TransactionStatusenum of Type WSTransactionStatusPossible 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
  • __NONE
  • Resolved
  • Unauthorized
  • Pending
SettlementStatusenum of Type WSSettlementStatusPossible responses are:
  • No_Settlement_Needed
  • To_Be_Originated
  • Originating
  • Originated_Settlement_Pending
  • Settling
  • Settled
  • Charged_Back
  • __NONE
  • Originated SDACH (For future use)
  • Settled SDACH (For future use)
EffectiveDatedateTimeDate and time the transaction was processed.
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.
ShippingAmountdecimalNot used at this time.
SalestringApplicable to Credit Card transactions only.
ConvenienceFeeAmountstringApplicable to Credit Card transactions only. Fee added to the face value of the transaction.
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.
Field2string50Optional information associated with the transaction. Not returned in response if not used.
Field3string50Optional information associated with the transaction. Not returned in response if not used.
CheckMICRLinestringNot returned in response.
CheckMICRSymbolSetstringNot returned in response.
RoutingNumberstring9Zeroes will display for Credit Card transactions.
AccountNumberstring17Last 4 digits only displayed.
CheckNumberstring17
SwipeTrack1stringNot returned in response.
SwipeTrack2stringNot returned in response.
SwipeTrack3stringNot returned in response.
CardExpiresMonthbyteA value of ‘0’ will be returned.
CardExpiresYearshortA value of ‘0’ will be returned.
CVVNumberintA value of ‘0’ will be returned.
IsBusinessPaymentboolTrue or False. Identifies the transaction as either a business or personal.
NameOnAccountstring50Customer’s name as it appears on their account.
BillingAddress1string50Customer's address, if available. Not returned in response if there is no other customer information available.
BillingAddress2string50Customer's additional address info, 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. if available. Not returned in response if there is no other customer information available.
IPAddressOfOriginatorstring15IP address of person sending request, 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.
NotificationMethodenum of Type WSNotificationMethodPossible responses are:
  • Merchant_Notify
  • Merchant_Recording
  • Postcard
  • Email
FaceFeeTypeenum of Type WSFaceFeeTypePossible responses are:
  • __None
  • Face
  • Bill_Convenience_Face
  • NSF_Fee
  • Convenience_Fee
  • Bill_Convenience_Fee
CheckFrontImageBytes_TiffG4BinaryG4 Compressed Tiff image of the front of a scanned check. This field will only be returned if this is a scanned transaction and includeImages = True.
CheckRearImageBytes_TiffG4BinaryG4 Compressed Tiff image of the back of a scanned check. This field will only be returned if this is a scanned transaction and includeImages = True.
OptionalThirdImageBytes_TiffG4BinaryG4 Compressed Tiff image of a scanned optional document

(Merchant Capture). This field will only be returned if this is a scanned transaction and includeImages = True.
OptionalThirdImageDescriptionstring50This 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.
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.