Overview
This service retrieves a list of batches that match search criteria.
Security
The user must have the Gateway.User role and the ClientID must be in the Client Tree for the authenticated user.
SOAP Service
Request
<FindBatches xmlns="https://gateway.acheck21.com/GlobalGateway/"> <Username>string</Username> <Password>string</Password> <ClientID>string</ClientID> <Query>XML</Query> </FindBatches>
Response
<FindBatchesResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<FindBatchesResult> <Code>int</Code> <Message>string</Message>
<BatchCount>int</BatchCount> <Batches> <BatchNbr>int</BatchNbr> ... <BatchNbr>int</BatchNbr> </Batches> </FindBatchesResult>
<FindBatchesResponse>
REST Service
| URL | https://gateway.acheck21.com/GlobalGateway/REST/batches/<ClientID>?<Query> |
| VERB | GET |
| Response | A series of the following: |
| <uri>uri-to-batch</uri> | |
| The first element is a direct URI for this batch; the second represents the URI that can be used to retrieve the list of transactions in this batch. |
Possible values for <Code>
| Code | HTTP Status Code | Description |
| 0 | 204 | No error |
| 10000 | 401 | Not authorized |
| 10005 | 400 | Parameter error |
Query-able fields
| UploadDate | The date the batch was originally uploaded |
| Status | One of Pending, Rejected, Approved, Deleted |
| BatchNbr | The system-assigned batch number |
| SeqNbr | The user-assigned sequence (batch) number for the batch in which the item was originally uploaded |
For more information on how to generate valid <Query> values, please visit the following article:
http://help.acheck21.com/hc/en-us/articles/204143405-Concept-ACHeck21-XML-Query-Language
Comments