BATCHOPEN
The BATCHOPEN command creates a Batch object and, if successful, puts the batch into Open state. This command is only permissible if the account allows merchants to open batches.
Note: In a scenario where there is one merchant (123456789), with
two accounts (acct#1, acct#2), if a BatchOpen is issued with acct#1, batch#1,
the batch will open. When a BatchOpen is sent with acct#2, batch#1, the BatchOpen
will fail and the following message is displayed:
Tue Jun22 13:04:31 EDT 1999 CEPFW0715: Batch ID 299 already exists for
Merchant 123456789 and account 2.
The second test will fail because only one batch with a given BatchNumber can be in the system at any one time.
| Keywords | Required | Value |
|---|---|---|
| ACCOUNTNUMBER | Yes | Integer in ASCII characters. This value is a unique ID that indicates the acquirer to the merchant. The value must match the WebSphere Commerce Payments configured AccountNumber value. Must be from 1 to 999999999. |
| 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 BatchOpen. |
| PAYMENTTYPE | Yes | ASCII character string that identifies the payment cassette or protocol. |