Overview
This service provides for programmatic approval of a batch of transactions. Approval releases the transactions in the batch into the ACH or Check21 system for collection. Batches which have been approved cannot be edited or deleted. The operation will fail if the batch is not in the Pending state.
Security
The user must have the Gateway.Deposit role and the ClientID must be in the Client Tree for the authenticated user.
SOAP Service
Request
<ApproveBatch xmlns=“https://gateway.acheck21.com/GlobalGateway/”> <Username>string</Username> <Password>string</Password> <ClientID>string</ClientID> <BatchNbr>string</BatchNbr> </ApproveBatch>
Response
<ApproveBatchResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<ApproveBatchResult> <Code>int</Code> <Message>string</Message> </ApproveBatchResult>
</ApproveBatchResponse>
REST Service
URL | https://gateway.acheck21.com/GlobalGateway/REST/batch/<ClientID>/<Batch#>/approve |
VERB | PUT |
Response | empty |
Possible values for <Code>
Code | HTTP Status Code | Description |
0 | 204 | No error |
10000 | 401 | Not authorized |
10001 | 404 | Item not found |
10002 | 403 | Batch not in Pending state |
Comments