Web Service: GetChecks

Overview

This service returns check detail information (see the GetCheck service) for one or more checks identified by CheckID.

Security

The user must have either the Gateway.User role and the ClientID that created the check must be in the Client Tree for the authenticated user. Return information will only be provided if the user also has the Gateway.Returns role.

 

SOAP Service

Request

<GetChecks xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <Username>string</Username>
    <Password>string</Password>
    <CheckIDs>
        <CheckID>int</CheckID>
        ...
        <CheckID>int</CheckID>
    </CheckIDs>
</GetChecks>

 

Response

<GetChecksResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <GetChecksResult>
        <Code>int</Code>
        <Message>string</Message>
        <Checks>
            <CheckInfo>...</CheckInfo>
            ...
            <CheckInfo>...</CheckInfo>
        </Checks>
    </GetChecksResult>
</GetChecksResponse>

 

REST Service

There is no REST version of this service at this time

 

Possible values for <Code>

Code	HTTP Status Code	Description
0	200	No error
10000	401	Not authorized
0	204	No items found

 

Notes

The CheckInfo structure returned by the web service has the following C# definition:

public class CheckInfo {
    public int CheckID { get; set; }
    public string UploadDate { get; set; }
    public string IndividualName { get; set; }
    public string CheckNumber { get; set; }
    public string TransitNumber { get; set; }
    public string DDANumber { get; set; }
    public AccountType AccountType { get; set; }
    public Decimal CheckAmount { get; set; }
    public string ClientTag { get; set; }
    public string EntryClass { get; set; }
    public DateTime PostingDate { get; set; }
    public bool SentToFed { get; set; }
    public Return[] ReturnStatus { get; set; }
}