Class GetBatchesResponse
Results from a GetBatchesRequest.
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. |
| Batches | Batch[] | The list of batches. |
Batch
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| BatchNumber | System.String | A string value that can be assigned by the user to correlate to the Financial Institution's system or auto generated by the EPS system if left blank. This value must be unique. Also known as Deposit Name. Refer to GetSettingsRequest Class ShowCustomBatchID. Conditional field. Max 40 characters. |
| BatchReference | System.String | This is a unique string value assigned to a batch by EPS from the CreateBatchRequest. |
| Events | JackHenry.Eps.Mobile.Event[] | Events that have occured on the batch. |
| LocationName | System.String | A string value defining the location for the type of deposit. Possible values: Mobile Consumer Capture or Mobile MicroBusiness Capture. |
| Status | System.String | The Batch status code. |
| StatusDescription | System.String | The Batch status description to be displayed. |
| TotalAmount | System.Decimal | The amount of the items in the batch in DECIMAL format. |
| TotalCount | System.Decimal | The number of items in the batch. |
Examples
{
"__type": "GetBatchesResponse:#JackHenry.Eps.Mobile.RDA",
"Batches": [
{
"__type": "Batch:#JackHenry.Eps.Mobile.RDA",
"LocationName": "String Content",
"BatchReference": "String Content",
"BatchNumber": "String Content",
"Status": "String Content",
"StatusDescription": "String Content",
"TotalAmount": 12678967.54,
"TotalCount": 12678967.54,
"Events": []
}
]
}
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 |