BATCHPURGE
The BATCHPURGE command clears out a batch and returns the Batch object to Open state. All Payment and Credit objects associated with this batch are removed from the batch, with Payment objects returned to Approved state and Credit objects returned to Void state. This command is only permissible if the PurgeAllowed attribute is set to true.
| Keywords | Required | Value |
|---|---|---|
| BATCHNUMBER | Yes | A numeric string of up to nine characters. Must be from 1 to 999999999. |
| DTDPATH | No | Path to the locally stored DTD. The value of this parameter is used in the XML document to specify the location of the external DTD. If this parameter is not specified, the complete DTD is returned as an internal DTD. The length of the DTDPath must be from 1 to 254 bytes. |
| ETAPIVERSION | Yes | 3 (Indicates WebSphere Commerce Payments-or predecessor product-API version: Version 2.1.x, 2.2.x, 3.1.x, 5.5.x, and 5.6.x) |
| MERCHANTNUMBER | Yes | Integer in ASCII characters. Must be from 1 to 999999999. |
| OPERATION | Yes | ASCII character string BatchPurge. |