Overview
This service deletes an existing item from the system. This is only possible until the item is submitted into the processing queue, at which point there is nothing that can be done to the item.
Security
The user must have the Gateway.E-Check role (or Gateway.CreateRCC if deleting an RCC transaction) and the ClientID that created the check must be in the Client Tree for the authenticated user.
SOAP Service
Request
<DeleteCheck xmlns="https://gateway.acheck21.com/GlobalGateway/"> <Username>string</Username> <Password>string</Password> <CheckID>string</CheckID> </DeleteCheck>
Response
<DeleteCheckResponse xmlns="https://gateway.acheck21.com/GlobalGateway/">
<DeleteCheckResult> <Code>int</Code> <Message>string</Message> </DeleteCheckResult>
</DeleteCheckResponse>
REST Service
| URL | https://gateway.acheck21.com/GlobalGateway/REST/check/<CheckID #> |
| 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 |
Notes
The code of 10001 (Item not found) can result from either a programming error (passing an incorrect CheckID) or from attempting to delete a check once it has been submitted to the ACH system. At this moment, the only way to distinguish would be to follow a 10001 return code with a call to GetCheck with the same CheckID. If the check has been submitted, the item will be found by that service.
Comments