Overview
This service allows for deleting of a batch before approval. The batch is actually moved into the Deleted state, but it is not possible to do anything further with it. The operation will not fail if the batch was already deleted.
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
<DeleteBatch xmlns="https://gateway.acheck21.com/GlobalGateway/"> <Username>string</Username> <Password>string</Password> <ClientID>string</ClientID> <BatchNbr>string</BatchNbr> </DeleteBatch>
Response
<DeleteBatchResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<DeleteBatchResult> <Code>int</Code> <Message>string</Message> </DeleteBatchResult>
</DeleteBatchResponse>
REST Service
| URL | https://gateway.acheck21.com/GlobalGateway/REST/batch/<ClientID>/<Batch#> |
| VERB | DELETE |
| Response | empty |
Possible values for <Code>
| Code | HTTP Status Code | Description |
| 0 | 204 | No error |
| 10000 | 401 | Not authorized |
| 10001 | 404 | Item not found |
Comments