Class GetItemByItemIdResponse
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:
| |
| ItemStatus | WSItemStatus | Possible responses are:
| |
| IsDuplicate | bool | Possible responses are:
| |
| 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:
| |
| ActualOriginatedAsID | WSSettlementType | Possible responses are:
| |
| RecoStatus | byte | Possible responses are:
| |
| AmountSource | WSAmountSource | Possible responses are:
| |
| IQUStatus | byte | Possible responses are:
| |
| ImageQualityPass | bool | Possible responses are:
| |
| MICRSource | WSMICRSource | Possible responses are:
| |
| AuthResponseCode | WSAuthResponseCode | Valid values are:
| |
| PaymentType | WSPaymentType | Possible response are:
| |
| SettlementType | WSSettlementType | Possible response are:
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:
| |
| 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. |
| FrontImage | Binary | This field will only be returned if this is a scanned check transaction and includeImages = 1 (true). | |
| RearImage | Binary | This field will only be returned if this is a scanned check transaction and includeImages = 1 (true). |
WSPaymentOrigin
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| __NONE | 0 | |
| Mailed_In | 1 | |
| Back_Office | 2 |
WSItemStatus
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Created | 0 | |
| Closed | 1 | |
| Approved | 2 | |
| Error | 3 | |
| Released | 4 | |
| Rejected | 5 | |
| Resolved | 6 | |
| Deleted | 7 | |
| SentToTransactionProcessing | 8 | |
| TPError | 9 | |
| NeedsRescan | 10 | |
| NeedsAttention | 11 | |
| Rescanned | 12 | |
| CheckDecisioningError | 13 | |
| None | 255 |
WSSettlementType
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| NONE | 0 | |
| ACH | 1 | |
| Image_Replacement_Document | 2 | |
| __NONE | 3 |
WSAmountSource
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| MICR | 0 | |
| CAR | 1 | |
| APEXKeyed | 2 | |
| Customer | 3 | |
| Keyed | 4 | |
| None | 250 |
WSMICRSource
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Document | 0 | |
| CAR | 1 | |
| APEXKeyed | 2 | |
| OrbographRepaired | 3 | |
| MICRRepair | 4 | |
| None | 250 |
WSAuthResponseCode
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Success | 0 | |
| Duplicate_Transaction | 10 | |
| Declined | 19 | |
| Data_Not_Valid | 20 | |
| Velocity_Count | 27 | |
| Velocity_Amount | 28 | |
| Customer_Opt_Out_Conversion | 32 | |
| Account_Not_ACHable | 52 | |
| Account_Invalid_Routing | 56 | |
| Error_Invalid_Format | 201 | |
| Error_Timeout | 202 | |
| Error_Internal | 203 | |
| Error_Connection | 204 | |
| Error_Not_Supported | 205 | |
| Error_Not_Subscribed | 206 | |
| Error_Batch_Closed | 207 | |
| Error_Invalid_Batch | 208 | |
| Error_Invalid_Terminal | 209 | |
| Error_Transaction_Not_Found | 210 | |
| Error_Terminal_Disabled | 211 | |
| Error_Invalid_State | 212 | |
| Error_MaxData_Exceeded | 213 | |
| Error_Unspecified | 254 | |
| __NONE | 255 |
WSPaymentType
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| __NONE | 0 | |
| Checking | 1 | |
| Savings | 2 | |
| Money_Order | 3 | |
| Travelers_Check | 4 | |
| Convenience_Check | 5 | |
| Cashiers_Check | 6 | |
| Treasury_Check | 7 |
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>