Live Support Agent

Web Service: FindReturns

Bret Hillbun -

Overview

This service returns a list of CheckIDs for returned documents that match the specified criteria.

Security

The user must have the Gateway.Returns role and the ClientID must be in the Client Tree for the authenticated user.

 

SOAP Service

Request

<FindReturns xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <Username>string</Username>
    <Password>string</Password>
    <ClientID>string</ClientID>
    <Query>XML</Query>
</FindReturns>

 

Response

<FindReturnsResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <FindReturnsResult>
        <Code>int</Code>
        <Message>string</Message>
        <Checks>
            <CheckID>int</CheckID>
            ...
            <CheckID>int</CheckID>
        </Checks>
    </FindReturnsResult>
</FindReturnsResponse>

 

REST Service

URL https://gateway.acheck21.com/GlobalGateway/REST/checks/<ClientID>/returns?<Query>
VERB GET
Response A series of the following:
  <uri>uri-to-returned-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
ReturnDate The date the item was returned
ReturnCode The NACHA return code to search for. A list of recognized NACHA codes (including several provided by ACHeck21® for image returns) can be found at ACHeck21/NACHA return code list.
SeqNbr The user-assigned batch number for the originally uploaded document.

 

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

Have more questions? Submit a request

Comments