Skip to main content

Class GetTransactionByTransactionNumberResponse


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
  • __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
  • Originated SDACH (for future use)
  • Settled SDACH (for future use)
EffectiveDatedateTime19Date 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
TransactionNumberstringUnique identifier of the transaction being requested.
Field1stringOptional information associated with the transaction. Not returned in response if not used.
Field2stringOptional information associated with the transaction. Not returned in response if not used.
Field3stringOptional information associated with the transaction. Not returned in response if not used.
CheckMICRLinestringNot returned in response.
CheckMICRSymbolSetstringNot returned in response.
RoutingNumberstringZeroes will display for credit card transactions.
AccountNumberstringLast 4 digits only displayed.
CheckNumberstring
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.
NameOnAccountstringCustomer’s name as it appears on their account.
BillingAddress1stringCustomer’s address, if available.
BillingAddress2stringCustomer’s additional address info, if available
BillingCitystringCity where the customer resides.
BillingStateRegionstringState in which the customer resides.
BillingPostalCodestringZip code where the customer resides.
BillingCountrystringCountry in which the customer resides.
BillingPhonestringCustomer’s telephone number, if available.
IPAddressOfOriginatorstringIP address of person sending request.
EmailAddressstringCustomer’s email address if available.
SSNstringCustomer’s Social Security Number, if available.
DLStatestringState where the customer’s driver’s license is registered, if available.
DLNumberstringCustomer’s driver’s license number, if 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.
OptionalThirdImageDescriptionstringThis field will only be returned if this is a scanned check transaction and includeImages = True.
PresentmentNumberintA value of “0” will be returned.
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.