Skip to main content

Class GetItemsByDateRangeResponse


Properties

NAMETYPEDESCRIPTION
WSRemoteDepositItemWSRemoteDepositItem[]

WSRemoteDepositItem

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
AuthResponseCodestringValid 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.

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>
<GetItemsByDateRangeResponse xmlns="https://ssl.selectpayment.com/">
<GetItemsByDateRangeResult>
<WSRemoteDepositItem>
<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>SentToTransactionProcessing</ItemStatus>
<IsDuplicate>false</IsDuplicate>
<NameOnAccount>Jordan R Gish</NameOnAccount>
<CheckNumber>1080</CheckNumber>
<TotalAmount>51.4000</TotalAmount>
<Description/>
<Field1>123456789</Field1>
<Field2>11007</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>
<ReferenceNumber>T:TXFYW0X7w</ReferenceNumber>
<AccountNumber>12-1234-12</AccountNumber>
<RoutingNumber>91904267</RoutingNumber>
<MICR>>t091904267t 12-1234-12o 1080</MICR>
</WSRemoteDepositItem>
<WSRemoteDepositItem>
<ItemId>187935203</ItemId>
<EntityId>12345</EntityId>
<LocationId>102031</LocationId>
<CustomerNumber>24678</CustomerNumber>
<ItemDateTime>2011-03-03T07:48:11.053</ItemDateTime>
<BatchNumber>1101</BatchNumber>
<TerminalNumber>5421769</TerminalNumber>
<PaymentOrigin>Mailed_In</PaymentOrigin>
<ItemStatus>SentToTransactionProcessing</ItemStatus>
<IsDuplicate>false</IsDuplicate>
<NameOnAccount>Jane Doe</NameOnAccount>
<CheckNumber/>
<TotalAmount>25.0000</TotalAmount>
<Description/>
<Field1>204L</Field1>
<Field2/>
<Field3/>
<Deleted>false</Deleted>
<ActualOriginatedAsID>Image_Replacement_Document</ActualOriginatedAsID>
<RecoStatus>2</RecoStatus>
<AmountSource>Keyed</AmountSource>
<IQUStatus>2</IQUStatus>
<ImageQualityPass>true</ImageQualityPass>
<MICRSource>Document</MICRSource>
<AuthResponseCode>Success</AuthResponseCode>
<PaymentType>Checking</PaymentType>
<SettlementType>Image_Replacement_Document</SettlementType>
<RescanCount>0</RescanCount>
<SequenceNumber>2</SequenceNumber>
<ReferenceNumber>T:VXFYW0X7w</ReferenceNumber>
<AccountNumber>65-0000218932</AccountNumber>
<RoutingNumber>800000051</RoutingNumber>
<MICR> t800000051t 65-0000218932o </MICR>
</WSRemoteDepositItem>
<WSRemoteDepositItem>
<ItemId>177515253</ItemId>
<EntityId>12345</EntityId>
<LocationId>102031</LocationId>
<CustomerNumber>3</CustomerNumber>
<ItemDateTime>2011-03-03T07:48:12.427</ItemDateTime>
<BatchNumber>1101</BatchNumber>
<TerminalNumber>5421769</TerminalNumber>
<PaymentOrigin>Mailed_In</PaymentOrigin>
<ItemStatus>TPError</ItemStatus>
<IsDuplicate>false</IsDuplicate>
<NameOnAccount>Mark Smith</NameOnAccount>
<CheckNumber>4322344</CheckNumber>
<TotalAmount>47.4000</TotalAmount>
<Description/>
<Field1/>
<Field2/>
<Field3/>
<Deleted>false</Deleted>
<ActualOriginatedAsID>None</ActualOriginatedAsID>
<RecoStatus>2</RecoStatus>
<AmountSource>CAR</AmountSource>
<IQUStatus>2</IQUStatus>
<ImageQualityPass>true</ImageQualityPass>
<MICRSource>Document</MICRSource>
<AuthResponseCode>Duplicate_Transaction</AuthResponseCode>
<PaymentType>Checking</PaymentType>
<SettlementType>Image_Replacement_Document</SettlementType>
<RescanCount>0</RescanCount>
<SequenceNumber>3</SequenceNumber>
<ReferenceNumber>T:WXFYW0X7w</ReferenceNumber>
<AccountNumber>45645564456</AccountNumber>
<RoutingNumber>111000025</RoutingNumber>
<MICR>o4322344o t111000025t 45645564456o</MICR>
</WSRemoteDepositItem>
</GetItemsByDateRangeResult>
</GetItemsByDateRangeResponse>
</soap:Body>
</soap:Envelope>