Skip to main content

Class TransactionByTransactionIdResponse


Properties

NAMETYPELENGTHDESCRIPTION
RequestIdintValue provided by the user to identify the request. The element can be blank or null.
ResultResultPossible responses are:
  • Success
  • Error
MessagestringMessage text to display to client.
ResultsC21TransactionC21Transaction details

C21Transaction

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.