BATCHCLOSE
The BATCHCLOSE command closes a batch and moves the Batch object into Closed state. All Payment and Credit objects associated with this batch move to Closed state as well.
This command is only permissible if:
- The batch is in Open state
- The account allows the merchant to close the batch
- The merchant control 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) |
| FORCE | No | Valid values are 0 and 1. A value of 1 indicates a local close should be performed even if the financial operation fails. |
| MERCHANTNUMBER | Yes | Integer in ASCII characters. Must be from 1 to 999999999. |
| OPERATION | Yes | ASCII character string BatchClose. |