Class AddItemResponse
Results from a AddItemRequest.
Properties
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| RequestId | System.string | Unique identifier used to identify the request associated with the response. |
| Result | ResponseResultType | Value indicating type of result. Possible values: Error (default), Success, ValidationError, NoChange |
| ResultCode | System.string | Can be Error or Resource code depending on type of result. |
| ResultMessage | System.string | Message regarding details of the Result. |
| ValidationResults | ValidationResult[] | Array of ValidationResult objects containing messages regarding input validation. |
| Credentials | TokenCredentials | A security token representing an authenticated user which will be used in subsequent calls. The token expires after 20 minutes. |
| CheckFaceInfo | CheckFaceInfo | The info from the check face. |
| Item | Item | The item information for the newly added item. |
CheckFaceInfo
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| AccountNumber | System.String | Bank account number off the check. |
| Amount | System.Decimal | Dollar amount on check. |
| CheckNumber | System.String | Check number off the check. |
| RoutingNumber | System.String | Bank routing number off the check. |
Item
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| AccountName | System.String | A string value with the Nickname of the account intended to display to the user. This correlates to the Name from the AddAccount class. Max length 50 characters. Required field. |
| Amount | System.String | The amount in DECIMAL format of an individual check item. |
| BatchReference | System.String | This is a unique string value assigned to a batch by EPS from the CreateBatchRequest. This references the batch containing the item. |
| Events | JackHenry.Eps.Mobile.Event[] | Events that were performed on an individual check item. |
| IQAStatus | System.String | Image quality status. |
| ItemReference | System.String | REQUIRED. String Value. The item reference number associated with a specific item in a batch used to find more details about the item. Provided in the AddItem response. |
| Memo | System.String | Deposit reference information that is provided by the depositor. The maximum length of the field is 50 characters with no restrictions on the type of character and is OPTIONAL. |
| ProcessingStatus | System.String | Once a transaction is created, this will have a value and contain the processing status code. NOTE: Show this status once a transaction is created. For example, show this status when the user clicks on a mobile deposit "Review" page. |
| ProcessingStatusDescription | System.String | Once a transaction is created, this will have a value and will contain the processing status to be displayed. |
| Status | System.String | The status code of the item. NOTE: Show this status until a transaction is created - then show the "Processing Status". |
| StatusDescription | System.String | The status description to be displayed. |
| TransactionReferenceNumber | System.String | A unique string value assigned to each transaction. The value is systematically assigned by EPS. |
Examples
{
"__type":"AddItemResponse:#JackHenry.Eps.Mobile.RDA",
"Item":
{
"__type":"Item:#JackHenry.Eps.Mobile.RDA",
"ItemReference":"String Content",
"BatchReference":"String Content",
"TransactionReferenceNumber":"String Content",
"Status":"String Content",
"StatusDescription":"String Content",
"ProcessingStatus":"String Content",
"ProcessingStatusDescription":"String Content",
"Amount":12678967.54,
"IQAStatus":"String Content",
"Events":
[
],
"AccountName":"String Content",
"AccountReferenceID": "String Content",
"Memo":"String Content",
}
"CheckFaceInfo":
{
"__type":"CheckFaceInfo:#JackHenry.Eps.Mobile.RDA",
"RoutingNumber":"String Content",
"AccountNumber":"String Content",
"CheckNumber":"String Content",
"Amount":12678967.54,
}
}
Methods
Exception(string)
Declaration
public void Exception(string message)
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| System.String | message |
NullRequestResonse()
Declaration
public static Response NullRequestResonse()
Return Value
| TYPE | DESCRIPTION |
|---|---|
| Response |
Success()
Declaration
public void Success()
Success(String)
Declaration
public void Success(string resultMessage)
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| System.String | resultMessage |