Web Service: GetCheck

Overview

This service retrieves a single document. To retrieve more than one document, use the services of the Checks entity. CheckIDs are returned by the FindChecks and CreateCheck services.

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 is unavailable on this web method's response.

 

SOAP Service

Request

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

 

Response

<GetCheckResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <GetCheckResult>
        <Code>int</Code>
        <Message>string</Message>
        <CheckInfo>
            <CheckID>int</CheckID>
            <UploadDate>datetime</UploadDate>
            <IndividualName>string</IndividualName>
            <CheckNumber>string</CheckNumber>
            <TransitNumber>string</TransitNumber>
            <DDANumber>string</DDANumber>
            <AccountType>string</AccountType>
            <CheckAmount>string</CheckAmount>
            <EntryClass>string</EntryClass>
            <ClientTag>string</ClientTag>
            <SentToFed>bool</SentToFed>
        </CheckInfo>
    </GetCheckResult>
</GetCheckResponse>

 

REST Service

URL	https://gateway.acheck21.com/GlobalGateway/REST/check/<CheckID>
VERB	GET
Response	Same as the SOAP response

 

Possible values for <Code>

Code	HTTP Status Code	Description
0	200	No error
10000	401	Not authorized
10001	404	Item not found

 

Notes
The SentToFed flag returned by the service will be true if the item has been sent via either the ACH or Check21 systems. If this flag is false, then the item can still be deleted or updated.