Skip to main content

Class GetItemByItemIdResponse


Properties

NAMETYPELENGTHDESCRIPTION
ItemIdlongA unique system assigned value that identifies the specific transaction being requested.
EntityIdintA unique identifier that is generated by EPS.
LocationIdintA unique identifier generated by EPS for each location.
CustomerNumberstring50A unique identifier that references a specific customer.
ItemDateTimeDateTimeThe date and time the transaction was processed.
BatchNumberstring40A unique identifier of the batch that is being requested.
TerminalNumberstring20This is the serial number of the terminal used to scan the transactions.
PaymentOriginWSPaymentOriginPossible responses are:
  • __NONE
  • Mailed_In
  • Back_Office
ItemStatusWSItemStatusPossible responses are:
  • Created
  • Closed
  • Approved
  • Error
  • Released
  • Rejected
  • Resolved
  • Deleted
  • SentToTransactionProcessing
  • TPError
  • NeedsRescan
  • NeedsAttention
  • Rescanned
  • CheckDecisioningError
  • None
IsDuplicateboolPossible responses are:
  • true – this is a duplicate item
  • false – this is not a duplicate item
NameOnAccountstring50The maker of the check, if available.
CheckNumberstring17The check serial number.
TotalAmountDecimalThe amount of the check.
Descriptionstring50Optional information associated with the transaction. This field will only be returned if optional key entry is enabled.
Field1string50Optional information associated with the transaction. This field will only be returned if optional key entry is enabled.
Field2string50Optional information associated with the transaction. This field will only be returned if optional key entry is enabled.
Field3string50Optional information associated with the transaction. This field will only be returned if optional key entry is enabled.
DeletedboolPossible responses are:
  • true
  • false
ActualOriginatedAsIDWSSettlementTypePossible responses are:
  • None / _NONE
  • ACH
  • Image_Replacement_Document
RecoStatusbytePossible responses are:
  • 0 = Nothing
  • 1 = Needs to be Performed
  • 2 = Done
  • 3 = Suspect
  • 4 = Failed
AmountSourceWSAmountSourcePossible responses are:
  • MICR
  • CAR
  • APEXKeyed
  • Customer
  • Keyed
  • None
IQUStatusbytePossible responses are:
  • 0 = Nothing
  • 1 = Needs to be Performed
  • 2 = Done
  • 3 = Suspect
  • 4 = Failed
ImageQualityPassboolPossible responses are:
  • true
  • false
MICRSourceWSMICRSourcePossible responses are:
  • Document
  • CAR
  • APEXKeyed
  • OrbographRepaired
  • MICRRepair
  • None
AuthResponseCodeWSAuthResponseCodeValid values are:
  • Success
  • Duplicate_Transaction
  • Declined
  • Data_Not_Valid
  • Velocity_Count
  • Velocity_Amount
  • Customer_Opt_Out_Conversion
  • Account_Not_ACHable
  • Account_Invalid_Routing
  • Error_Invalid_Format
  • Error_Timeout
  • Error_internal
  • Error_Connection
  • Error_Not_Subscribed
  • Error_Batch_Closed
  • Error_Invalid_Batch
  • Error_Invalid_Terminal
  • Error_Transaction_Not_Found
  • Error_Terminal_Disabled
  • Error_Invalid_State
  • Error_MaxData_Exceeded
  • Error_Unspecified
  • __NONE
PaymentTypeWSPaymentTypePossible response are:
  • __NONE
  • Checking
  • Savings
  • Money_Order
  • Travelers_Check
  • Convenience_Check
  • Cashiers_Check
  • Treasury_Check
SettlementTypeWSSettlementTypePossible response are:
  • None / _NONE
  • ACH
  • Image_Replacement_Document


Note: The element SettlementType is equivalent to the ‘OriginatedAs’ option on the SmartPay Business.
RescanCountbyteThe number of times an item has been rescanned.

Possible response are:
  • 0 = the original scan of an item.
  • 1 = first time rescanned
  • 2 = second time rescanned
SequenceNumberintThe numerical position of the item within the batch.
ReferenceNumberstring20Reference number systematically assigned to the transaction.
AccountNumberstring17The account number on the scanned item.
RoutingNumberstring9The bank’s routing number on the scanned item.
MICRstring85This is the enire MICR line of the check.
FrontImageBinaryThis field will only be returned if this is a scanned check transaction and includeImages = 1 (true).
RearImageBinaryThis field will only be returned if this is a scanned check transaction and includeImages = 1 (true).

WSPaymentOrigin

NAMETYPEDESCRIPTION
__NONE0
Mailed_In1
Back_Office2

WSItemStatus

NAMETYPEDESCRIPTION
Created0
Closed1
Approved2
Error3
Released4
Rejected5
Resolved6
Deleted7
SentToTransactionProcessing8
TPError9
NeedsRescan10
NeedsAttention11
Rescanned12
CheckDecisioningError13
None255

WSSettlementType

NAMETYPEDESCRIPTION
NONE0
ACH1
Image_Replacement_Document2
__NONE3

WSAmountSource

NAMETYPEDESCRIPTION
MICR0
CAR1
APEXKeyed2
Customer3
Keyed4
None250

WSMICRSource

NAMETYPEDESCRIPTION
Document0
CAR1
APEXKeyed2
OrbographRepaired3
MICRRepair4
None250

WSAuthResponseCode

NAMETYPEDESCRIPTION
Success0
Duplicate_Transaction10
Declined19
Data_Not_Valid20
Velocity_Count27
Velocity_Amount28
Customer_Opt_Out_Conversion32
Account_Not_ACHable52
Account_Invalid_Routing56
Error_Invalid_Format201
Error_Timeout202
Error_Internal203
Error_Connection204
Error_Not_Supported205
Error_Not_Subscribed206
Error_Batch_Closed207
Error_Invalid_Batch208
Error_Invalid_Terminal209
Error_Transaction_Not_Found210
Error_Terminal_Disabled211
Error_Invalid_State212
Error_MaxData_Exceeded213
Error_Unspecified254
__NONE255

WSPaymentType

NAMETYPEDESCRIPTION
__NONE0
Checking1
Savings2
Money_Order3
Travelers_Check4
Convenience_Check5
Cashiers_Check6
Treasury_Check7

Examples

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetItemByItemIdResponse xmlns="https://ssl.selectpayment.com/">
<GetItemByItemIdResult>
<ItemId>187935201</ItemId>
<EntityId>12345</EntityId>
<LocationId>102031</LocationId>
<CustomerNumber>13579</CustomerNumber>
<ItemDateTime>2011-03-03T07:48:09.307</ItemDateTime>
<BatchNumber>1101</BatchNumber>
<TerminalNumber>5421769</TerminalNumber>
<PaymentOrigin>Mailed_In</PaymentOrigin>
<ItemStatus>Created</ItemStatus>
<IsDuplicate>false</IsDuplicate>
<NameOnAccount>Jordan R Gish</NameOnAccount>
<CheckNumber>1080</CheckNumber>
<TotalAmount>51.4000</TotalAmount>
<Description/>
<Field1>123456789</Field1>
<Field2>11077</Field2>
<Field3>Suite A</Field3>
<Deleted>false</Deleted>
<ActualOriginatedAsID>ACH</ActualOriginatedAsID>
<RecoStatus>2</RecoStatus>
<AmountSource>APEXKeyed</AmountSource>
<IQUStatus>2</IQUStatus>
<ImageQualityPass>true</ImageQualityPass>
<MICRSource>Document</MICRSource>
<AuthResponseCode>Success</AuthResponseCode>
<PaymentType>Checking</PaymentType>
<SettlementType>ACH</SettlementType>
<RescanCount>0</RescanCount>
<SequenceNumber>1</SequenceNumber>
<AccountNumber>12-1234-12</AccountNumber>
<RoutingNumber>91904267</RoutingNumber>
<MICR>t091904267t 12-1234-12o 1080</MICR>
<FrontImage>SUkqAAgAAAARAP4ABAABAAAAAAAAAAABAwABAAAAsAQAAAEBAwA
BAAAAKAIAAAIBAwABAAAAAQAAAAMBAwABAAAABAAAAAYBAwABAAAAAAAAAA
oBAwABAAAAAQAAABEBBAABAAAACgEAABIBAwABAAAAAQAAABUBAwABAAAAA
QAAABYBAwABAAAAKAIAABcBBAABAAAAYzIAABoBBQABAAAA2gAAABsBBQABAA
AA4gAAACUBBAABAAAAAAAAACgBAwABAAAAAgAAADEBAgAgAAAA6gAAAAAAAA
DIAAAAAQAAAMgAAAABAAAAQ29tcHJlc3NlZCB3aXRoIFBBT……QwrCgul4AIAIA==
</FrontImage>
<RearImage>SUkqAAgAAAARAP4ABAABAAAAAAAAAAABAwABAAAAsAQAAAEBAwA
BAAAAKAIAAAIBAwABAAAAAQAAAAMBAwABAAAABAAAAAYBAwABAAAAAAAAAA
oBAwABAAAAAQAAABEBBAABAAAACgEAABIBAwABAAAAAQAAABUBAwABAAAAA
QAAABYBAwABAAAAKAIAABcBBAABAAAAZREAABoBBQABAAAA2gAAABsBBQABA
AAA4gAAACUBBAABAAAAAAAAACgBAwABAAAAAgAAADEBAgAgAAAA6gAAAAAAA
ADIAAAAAQAAAMgAAAABAAAAQ29tcHJlc3NlZCB3aXRoIFBBTklOSSBJbWFnZSsAAAA
moEsCDCOI0yPk3NByBtBtHIGIKg+FMoTIGgFA5CjkeFDlVlWccqyNKJjlOU0FuQWwRz8U
OVBQ5H5fHOU0hfIZALEEIOZqDeRXIg5AsHJ6lNa4iIirr//v///////v//+r/////uv//q+///+v//7q///q+r//+
+v//+////////…… OgiIOUOIjI4EwOACAC
</RearImage>
</GetItemByItemIdResult>
</GetItemByItemIdResponse>
</soap:Body>
</soap:Envelope>