Overview
This service provides a mechanism for searching the system for deposited documents that match specified criteria. To search for items that have been submitted via the CreateCheck service but have not yet been batched, use the FindPendingChecks service.
SOAP Service
Request
<FindChecks xmlns="https://gateway.acheck21.com/GlobalGateway/"> <Username>string</Username> <Password>string</Password> <ClientID>string</ClientID> <Query>XML</Query> </FindChecks>
Response
<FindChecksResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<FindChecksResult> <Code>int</Code> <Message>string</Message> <Checks> <CheckID>int</CheckID> ... <CheckID>int</CheckID> </Checks> </FindChecksResult>
</FindChecksResponse>
REST Service
URL | https://gateway.acheck21.com/GlobalGateway/REST/checks/<ClientID>?<Query> |
VERB | GET |
Response | A series of the following: |
<uri>uri-to-check</uri> |
Possible values for <Code>
Code | HTTP Status Code | Description |
0 | 204 | No error |
10000 | 401 | Not authorized |
10001 | 404 | Item not found |
Query-able fields
UploadDate | The date the batch was originally uploaded |
ToFedDate | The date the item was deposited |
Amount | The check amount |
SeqNbr | The user-assigned sequence (batch) number for the batch in which the item was originally uploaded |
Name | The individual name on the item |
TransitNbr | The ABA routing / transit number |
AccountNbr | The bank account number (DDA) |
CheckNbr | The actual check number / item sequence number |
ClientTag | The original document client tag sent when the item was uploaded |
EntryClass | The ACH entry class code. Legal values are: 937, ARC, BOC, PPD, TEL, WEB, CCD |
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