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:
QUERYPAYMENTS
The QUERYPAYMENTS command returns a collection of WebSphere Commerce Payments Payment objects or unique payment identifiers (in the form "orderNumber: paymentNumber").

Deprecated feature

QUERYPAYMENTS

The QUERYPAYMENTS command returns a collection of WebSphere Commerce Payments Payment objects or unique payment identifiers (in the form "orderNumber: paymentNumber").

Required keywords and operational parameters for QueryPayments 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 "QueryPayments."


Optional search modifiers	Multiple allowed?	Value
BATCHNUMBER	Y	Integer in ASCII characters. Must be from 1 to 999999999.
BRAND	Y	Brand of customer's payment method. ASCII character string.
CREATEBEGINTIME	N	A date and time to be used as the lower limit of the create time of the payment. 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.
CREATEENDTIME	N	A date and time to be used as the upper limit of the create time of the payment. 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.
CURRENCY	N	The ISO 4217 currency code for amount values. Integer in ASCII characters. Must be exactly 3 characters long and should include leading zeroes if necessary.
MAXAPPROVEAMOUNT	N	Maximum approved amount. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MAXDEPOSITAMOUNT	N	Maximum deposit amount. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MERCHANTNUMBER	Y	Integer in ASCII characters. Must be from 1 to 999999999.
MINAPPROVEAMOUNT	N	Minimum approved amount. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MINDEPOSITAMOUNT	N	Minimum deposit amount. A Currency value must also be specified. A 32-bit positive integer in ASCII characters.
MODIFYBEGINTIME	N	A date and time to be used as the lower limit of the modify time of the payment. 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 payment. 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.
ORDERNUMBER	Y	Integer in ASCII characters. Must be from 1 to 999999999.
PAYMENTNUMBER	Y	Integer in ASCII characters. Must be from 1 to 999999999.
PAYMENTTYPE	Y	Integer in ASCII characters. Identifies the payment cassette or protocol. Maximum length is 10 bytes.
REFERENCENUMBER	Y	Merchant-assigned reference number for this payment. ASCII character string.
STATE	Y	An ASCII character string containing one of the following values: "payment_reset" "payment_approved" "payment_deposited" "payment_closed" "payment_declined" "payment_void" "payment_pending"

Optional operational parameters for QueryPayments command.
Optional operational parameters	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 payment identifiers (in the form "merchantNumber: orderNumber: paymentNumber") should be returned. 0: The complete objects will be returned.
RETURNATMOST	Specifies the maximum number of objects or unique payment 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.
WITHORDERS	1: PSOrder object should be located and returned with the payment objects. 0: Order will not be returned.