Overview
This service combines the FindPendingChecks and GetChecks services to retrieve the details of pending documents matching a specified criterion with a single round-trip. For the internal format of the CheckInfo returned, see the GetCheck service description.
Security
The user must have either the Gateway.User role and the ClientID must be in the Client Tree for the authenticated user.
SOAP Service
Request
<FindPendingChecksDetails xmlns="https://gateway.acheck21.com/GlobalGateway/"> <Username>string</Username> <Password>string</Password> <ClientID>string</ClientID> <Query>XML</Query> </FindPendingChecksDetails>
Response
<FindPendingChecksDetailsResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<FindPendingChecksDetailsResult> <Code>int</Code> <Message>string</Message> <Checks> <CheckInfo>...</CheckInfo> ... <CheckInfo>...</CheckInfo> </Checks> </FindPendingChecksDetailsResult>
</FindPendingChecksDetailsResponse>
REST Service
| URL | https://gateway.acheck21.com/GlobalGateway/REST/checks/<ClientID>/pending/details?<Query> |
| VERB | GET |
| Response | Same as the SOAP response |
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 |
| 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 routing / transit number (ABA) |
| 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