Skip to main content

Class WSRemoteDepositItem


Properties

| NAME | TYPE | LENGTH | DESCRIPTION | | -------------------- | --------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ItemId | long | | A unique system assigned value that identifies the specific transaction being requested. | | EntityId | int | | A unique identifier that is generated by EPS. | | LocationId | int | | A unique identifier generated by EPS for each location. | | CustomerNumber | string | 50 | A unique identifier that references a specific customer. | | ItemDateTime | DateTime | | The date and time the transaction was processed. | | BatchNumber | string | 40 | A unique identifier of the batch that is being requested. | | TerminalNumber | string | 20 | This is the serial number of the terminal used to scan the transactions. | | PaymentOrigin | WSPaymentOrigin | | | Possible responses are:

  • __NONE
  • Mailed_In
  • Back_Office
| | ItemStatus | WSItemStatus | | | Possible responses are:
  • Created
  • Closed
  • Approved
  • Error
  • Released
  • Rejected
  • Resolved
  • Deleted
  • SentToTransactionProcessing
  • TPError
  • NeedsRescan
  • NeedsAttention
  • Rescanned
  • CheckDecisioningError
  • None
| | IsDuplicate | bool | | | Possible responses are:
  • true – this is a duplicate item
  • false – this is not a duplicate item
| | NameOnAccount | string | 50 | The maker of the check, if available. | | CheckNumber | string | 17 | The check serial number. | | TotalAmount | Decimal | | The amount of the check. | | Description | string | 50 | Optional information associated with the transaction. This field will only be returned if optional key entry is enabled. | | Field1 | string | 50 | Optional information associated with the transaction. This field will only be returned if optional key entry is enabled. | | Field2 | string | 50 | Optional information associated with the transaction. This field will only be returned if optional key entry is enabled. | | Field3 | string | 50 | Optional information associated with the transaction. This field will only be returned if optional key entry is enabled. | | Deleted | bool | | | Possible responses are:
  • true
  • false
| | ActualOriginatedAsID | WSSettlementType | | | Possible responses are:
  • None / _NONE
  • ACH
  • Image_Replacement_Document
| | RecoStatus | byte | | | Possible responses are:
  • 0 = Nothing
  • 1 = Needs to be Performed
  • 2 = Done
  • 3 = Suspect
  • 4 = Failed
| | AmountSource | WSAmountSource | | | Possible responses are:
  • MICR
  • CAR
  • APEXKeyed
  • Customer
  • Keyed
  • None
| | IQUStatus | byte | | | Possible responses are:
  • 0 = Nothing
  • 1 = Needs to be Performed
  • 2 = Done
  • 3 = Suspect
  • 4 = Failed
| | ImageQualityPass | bool | | | Possible responses are:
  • true
  • false
| | MICRSource | WSMICRSource | | | Possible responses are:
  • Document
  • CAR
  • APEXKeyed
  • OrbographRepaired
  • MICRRepair
  • None
| | AuthResponseCode | string | | | Valid 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
| | PaymentType | WSPaymentType | | | Possible response are:
  • __NONE
  • Checking
  • Savings
  • Money_Order
  • Travelers_Check
  • Convenience_Check
  • Cashiers_Check
  • Treasury_Check
| | SettlementType | WSSettlementType | | | Possible response are:
  • None / _NONE
  • ACH
  • Image_Replacement_Document


Note: The element SettlementType is equivalent to the ‘OriginatedAs’ option on the SmartPay Business. | | RescanCount | byte | | | The 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
| | SequenceNumber | int | | The numerical position of the item within the batch. | | ReferenceNumber | string | 20 | Reference number systematically assigned to the transaction. | | AccountNumber | string | 17 | The account number on the scanned item. | | RoutingNumber | string | 9 | The bank’s routing number on the scanned item. | | MICR | string | 85 | This is the enire MICR line of the check. |

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

WSPaymentType

NAMETYPEDESCRIPTION
__NONE0
Checking1
Savings2
Money_Order3
Travelers_Check4
Convenience_Check5
Cashiers_Check6
Treasury_Check7