Live Support Agent

Web Service: GetBatch

Bret Hillbun -

Overview

This service allows for the retrievable of batch-specific information. Note that, unlike the version 1 service, you cannot retrieve the transactions themselves with this service (for that, use the FindChecksDetails service). Searching is provided using either the batch number (assigned by ACHeck21), the sequence number (assigned by the client). Searches need only specify one of these identifiers (although specifying more than one will not cause any negative side-effects, assuming that the different identifiers refer to a single item).

You can only retrieve a single batch with this service. To retrieve information about multiple batches, you must make multiple calls. 

 

SOAP Service

Request

<GetBatch xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <Username>string</Username>
    <Password>string</Password>
    <ClientID>string</ClientID>
    <BatchNbr>string</BatchNbr>
    <SeqNbr>string</SeqNbr>
</GetBatch>

 

Response

<GetBatchResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<GetBatchResult>     <Code>int</Code>      <Message>string</Message>     <BatchInfo>          <BatchNbr>int</BatchNbr>         <SeqNbr>int</SeqNbr>          <Filename>string</Filename>          <AcceptedCount>int</AcceptedCount>         <RejectedCount>int</RejectedCount>          <DuplicateCount>int</DuplicateCount>          <AcceptedAmount>double</AcceptedAmount>         <UploadDate>string</UploadDate>          <ApprovedDate>string</ApprovedDate>          <ApprovedBy>string</ApprovedBy>         <DeletedDate>string</DeletedDate>          <DeletedBy>string</DeletedBy>          <BatchStatus>string</BatchStatus>         <BatchTypeDescription>string</BatchTypeDescription>          <PendingDisbursment>double</PendingDisbursment>          <DisburseDate>string</DisburseDate>         <Returns>              <Count>int</Count>             <Total>double</Total>              <Date>string</Date>          </Returns>      </BatchInfo> </GetBatchResult>
</GetBatchResponse>

 

REST Service

URL https://gateway.acheck21.com/GlobalGateway/REST/batch/<ClientID>?<Query>
    OR
  https://gateway.acheck21.com/GlobalGateway/REST/batch/<ClientID>/<BatchNbr>
    WHERE <Query> is one of:
       batchnbr=<BatchNbr>
       seqnbr=<SeqNbr>
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
10005 400 Parameter error
Have more questions? Submit a request

Comments