Live Support Agent

Web Service: SendBatch

Bret Hillbun -

Overview

Accepts a Base64 encoded string of a batch file. This batch must follow the XML, CSV or XFR specification in ASCII character set. Unicode is not accepted. Documentation of these formats is provided separately.

It is important to note that the Batch loading system is an asynchronous procedure and the response code from this service purely represents the successful queuing of the batch for loading and does not mean a successful load. 

Security

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

 

SOAP Service

Request

<SendBatch xmlns="https://gateway.acheck21.com/GlobalGateway/">
    <Username>string</Username>
    <Password>string</Password>
    <ClientID>string</ClientID>
    <Base64EncodedBatch>string</Base64EncodedBatch>
    <Filename>string</Filename>
</SendBatch>

 

Response

<SendBatchResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<
SendBatchResult>      <Code>int</Code>     <Message>string</Message> </SendBatchResult>
</SendBatchResponse>

 

REST Service

URL https://gateway.acheck21.com/GlobalGateway/REST/batch/<ClientID>
VERB POST
Form contents The form must contain elements corresponding to the Base64EncodedBatch and Filename elements in the XML. These form elements must have the same names as in the XML.
Alternately, you can POST the XML, CSV or binary file directly, using multipart encoding, placing the file into a form element named BatchFile. This should be uploaded as if sent from an <input type=”FILE” name=”BatchFile” /> tag. In this latter case, the Filename field in the XML will be ignored (and need not be sent) and the name from the FILE element will be used in its place.
Response empty

 

Possible values for <Code>

Code HTTP Status Code Description
 0 204 No error
10000 401 Not authorized
10003 403 Base64 string not valid
10004 403 File format error
10005 400 Parameter error
10011 403 Duplicate item

 

Note

If the web service returns 10011 (Duplicate item), it is because a file with the same name was already uploaded, and the ACHeck21 system has not yet processed that file. Most of the time, waiting a couple of minutes and trying again will resolve the issue. However, once the original file is processed, uploading a second file with the same name will result in a duplication error on the Global Gateway. As a rule, different batches must have different SeqNbr's. Be aware that SendBatch will not normally return this error, as the back-end processing systems are usually quite fast.

Have more questions? Submit a request

Comments