ACHeck21 Gateway - Version 2.8


Click here for a complete list of operations.

GetBatch

Retrieves the details of a particular batch. To retrieve individual transactions, use FindChecks.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /GlobalGateway/WebServices/Gateway/2.8/Service.asmx HTTP/1.1
Host: gateway.acheck21.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://gateway.acheck21.com/GlobalGateway/GetBatch"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetBatch xmlns="https://gateway.acheck21.com/GlobalGateway/">
      <Username>string</Username>
      <Password>string</Password>
      <ClientID>string</ClientID>
      <BatchNbr>string</BatchNbr>
      <SeqNbr>string</SeqNbr>
    </GetBatch>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetBatchResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
      <GetBatchResult>
        <BatchInfo>
          <BatchNbr>int</BatchNbr>
          <SeqNbr>int</SeqNbr>
          <Filename>string</Filename>
          <AcceptedCount>int</AcceptedCount>
          <RejectedCount>int</RejectedCount>
          <DuplicateCount>int</DuplicateCount>
          <AcceptedAmount>string</AcceptedAmount>
          <UploadDate>string</UploadDate>
          <ApprovedDate>string</ApprovedDate>
          <ApprovedBy>string</ApprovedBy>
          <DeletedDate>string</DeletedDate>
          <DeletedBy>string</DeletedBy>
          <BatchStatus>string</BatchStatus>
          <BatchTypeDescription>string</BatchTypeDescription>
          <PendingDisbursment>string</PendingDisbursment>
          <DisburseDate>string</DisburseDate>
          <ReturnCount>int</ReturnCount>
          <ReturnAmount>string</ReturnAmount>
        </BatchInfo>
      </GetBatchResult>
    </GetBatchResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /GlobalGateway/WebServices/Gateway/2.8/Service.asmx HTTP/1.1
Host: gateway.acheck21.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetBatch xmlns="https://gateway.acheck21.com/GlobalGateway/">
      <Username>string</Username>
      <Password>string</Password>
      <ClientID>string</ClientID>
      <BatchNbr>string</BatchNbr>
      <SeqNbr>string</SeqNbr>
    </GetBatch>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetBatchResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
      <GetBatchResult>
        <BatchInfo>
          <BatchNbr>int</BatchNbr>
          <SeqNbr>int</SeqNbr>
          <Filename>string</Filename>
          <AcceptedCount>int</AcceptedCount>
          <RejectedCount>int</RejectedCount>
          <DuplicateCount>int</DuplicateCount>
          <AcceptedAmount>string</AcceptedAmount>
          <UploadDate>string</UploadDate>
          <ApprovedDate>string</ApprovedDate>
          <ApprovedBy>string</ApprovedBy>
          <DeletedDate>string</DeletedDate>
          <DeletedBy>string</DeletedBy>
          <BatchStatus>string</BatchStatus>
          <BatchTypeDescription>string</BatchTypeDescription>
          <PendingDisbursment>string</PendingDisbursment>
          <DisburseDate>string</DisburseDate>
          <ReturnCount>int</ReturnCount>
          <ReturnAmount>string</ReturnAmount>
        </BatchInfo>
      </GetBatchResult>
    </GetBatchResponse>
  </soap12:Body>
</soap12:Envelope>