Reference > WebSphere Commerce Payments command reference

Query commands

The following general rules apply to all queries:

• Each query has a set of search modifiers and a set of operational parameters. The modifiers determine the search criteria and the operational parameters affect the behavior or output of the command.

• All of the financial queries return either a "collection" or a "keyCollection" of the fundamental object being queried. The determination of collection versus keyCollection is made by the setting of the KEYSONLY parameter.

• Some keywords may be specified multiple times to achieve a search for a set of order values (for example, STATE=batch_opening, STATE=batch_open, STATE=batch_closed). For parameters that do not support multiple instances, WebSphere Commerce Payments will not return an error and makes no guarantee as to which value will be used.

• To control the query results size, applications may use the RETURNATMOST parameter. RETURNATMOST limits the number of objects or object identifiers returned for a given query, even if that number is less than the actual number of objects that match the query. The maximum number of objects that can be returned is ten thousand.

• You can specify the minimum role a user must have to be allowed to view sensitive data. For each query command, the framework will check the user's role against that minimum role and will set an indicator in the QueryRequest object to indicate whether sensitive data should be returned in full view or if it should be masked out. A JVM system parameter (wpm.MinSensitiveAccessRole) can be set by using the Configuration Manager to specify the role a user should have to view sensitive data (Clerk, Supervisor, Merchant Administrator, Payments Administrator, or none). For more information about setting the Minimum Access Role field in the Configuration Manager, refer to the Configuration Manager online help.

WebSphere Commerce Payments provides the following query commands:

• QUERYACCOUNTS
  The QUERYACCOUNTS command returns a collection of Account objects in XML format.

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

• QUERYCASSETTE
  A QUERYCASSETTE command returns a collection of Cassette objects in XML format.

• QUERYCREDITS
  The QUERYCREDITS command returns a collection of WebSphere Commerce Payments Credit objects or unique payment identifiers (in the form: "orderNumber: creditNumber").

• QUERYEVENTLISTENERS
  The QUERYEVENTLISTENERS command returns a collection of Event Listener objects.

• QUERYMERCHANTS
  The QUERYMERCHANTS command returns a collection of Merchant objects.

• QUERYORDERS
  The QUERYORDERS command returns a collection of PSOrder objects or order numbers.

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

• QUERYPAYMENTSERVER
  The QUERYPAYMENTSERVER command returns the Payment Server object.

• QUERYPAYSYSTEMS
  The QUERYPAYSYSTEMS command returns a collection of Payment System objects.

• QUERYUSERS
  The QUERYUSERS command returns a collection of User objects.

Related concepts

WebSphere Commerce Payments command reference

+

Search Tips   |   Advanced Search