Home
Reference
WebSphere Commerce Payments command reference
Parameters for the commands described here apply to the framework only. Note that in most cases, WebSphere Commerce Payments does not check for duplicate parameters. If more than one instance of a parameter is specified, then the last instance will be used.
Query commands
The following general rules apply to all queries:
QUERYBATCHES
The QUERYBATCHES command returns a collection of WebSphere Commerce Payments batch objects or batchkeys.

Deprecated feature

QUERYBATCHES

The QUERYBATCHES command returns a collection of WebSphere Commerce Payments batch objects or batchkeys.

Required keywords and operational parameters for QueryBatches command
Required keywords	Value
ETAPIVERSION	`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)
OPERATION	ASCII character string "QueryBatches."

Optional operational parameters for QueryBatches command.
Optional operational parameter	Value
DTDPATH	ASCII character string. Path to the locally-stored DTD. The value of this parameter will be used in the XML document to specify the location of the external DTD. If this parameter is not specified, the complete DTD will be returned as an internal DTD. The length of the DTDPath must be from 1 to 254 bytes.
KEYSONLY	1: Instead of returning the actual objects, only a list of unique batch identifiers (in the form "orderNumber:batchNumber") should be returned. 0: The complete objects will be returned.
RETURNATMOST	Specifies the maximum number of objects or unique credit identifiers to return for this call. This enables the application to control the amount of data returned by a given query call. A 32-bit positive integer in ASCII characters.
WITHCREDITS	1: All related PSCredit objects should be located and kept with the batch objects. 0: Credits will not be returned.
WITHPAYMENTS	1: All related PSPayment objects should be located and kept with the batch objects. 0: Payments will not be returned.


Optional search modifiers	Multiple allowed?	Value
ACCOUNTNUMBER	Y	Merchant's account with its financial institution. Integer in ASCII characters. Must be from 1 to 999999999.
BALANCESTATUS	Y	An ASCII character string containing one of the following values: "batch_not_yet_balanced" "batch_balanced" "batch_out_of_balance"
BATCHNUMBER	Y	Integer in ASCII characters. Must be from 1 to 999999999.
CLOSEALLOWED	N	1: Only batches which the merchant is allowed to close should be returned. 0: Only batches that will be closed by the financial institution should be returned. If this parameter is not specified, or if any other value is specified, then both types of batches will be returned.
CLOSEBEGINTIME	N	A date and time to be used as the lower limit of the close time of the batch. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24-hour clock), 01 January 1970.
CLOSEENDTIME	N	A date and time to be used as the upper limit of the close time of the batch. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24-hour clock), 01 January 1970.
MERCHANTNUMBER	Y	Integer in ASCII characters. Must be from 1 to 999999999.
MODIFYBEGINTIME	N	A date and time to be used as the lower limit of the modify time of the batch. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24-hour clock), 01 January 1970.
MODIFYENDTIME	N	A date and time to be used as the upper limit of the modify time of the batch. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24-hour clock), 01 January 1970.
OPENBEGINTIME	N	A date and time to be used as the lower limit of the open time of the batch. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24-hour clock), 01 January 1970.
OPENENDTIME	N	A date and time to be used as the upper limit of the open time of the batch. To be included in the query result. This value is specified in ASCII decimal digits as the number of milliseconds since midnight (00:00:00:000 on a 24-hour clock), 01 January 1970.
PAYMENTTYPE	Y	ASCII character string. Specifies the payment cassette or protocol. Value has a maximum length of 10 bytes.
STATE	Y	An ASCII character string containing one of the following values: "batch_opening" "batch_open" "batch_closing" "batch_closed"