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.

Clients send commands to WebSphere Commerce Payments by using HTTP POST requests, containing lists of keyword-value pairs. This section presents:

• WebSphere Commerce Payments financial and administrative commands

• Command descriptions

• List of required and optional keywords

• Guidelines regarding payment commands and query commands

Each command contains the name OPERATION. The value of the OPERATION parameter specifies the requested procedure.

In addition to OPERATION, ETAPIVERSION specifies the version number of the API. ETAPIVERSION is also required on every command.

Other name-value pairs in each command are dependent on the value of the OPERATION. The name-value pairs required by the payment operations are listed in the following tables. Other general guidelines for the name-value pairs include:

• The keyword strings are not case-sensitive.

• Do not use leading zeros for any integers in ASCII characters.

• ABOUT
  The ABOUT command is typically used in two ways:

• ACCEPTPAYMENT
  Use the ACCEPTPAYMENT command to create Order objects when an electronic wallet is not used. In general, if the command is successful, the order will be placed in Ordered state. If the command fails, the order will not be created. Pass protocol specific data on this command; however, specifics depend on the cassette.

• APPROVE
  The APPROVE command is used by the merchant to ask the financial system if the buyer should be allowed to make the purchase. For example, for a credit card system, this command would result in a credit card authorization.

• APPROVEREVERSAL
  An ApproveReversal command modifies the approved amount of a payment. For example, if a payment enters the ApprovalExpired state, then you can use the ApproveReversal command either to get a new approval or to void the payment. ApproveReversal is valid for payments in the Approved state. If the ApproveReversal is successful, and the amount specified is "0," then the payment moves to Void state. If the amount specified is not "0," then the payment stays in Approved state and the approved amount is modified.

• 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.

• 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.

• BATCHPURGE
  The BATCHPURGE command clears out a batch and returns the Batch object to Open state. All Payment and Credit objects associated with this batch are removed from the batch, with Payment objects returned to Approved state and Credit objects returned to Void state. This command is only permissible if the PurgeAllowed attribute is set to true.

• CANCELORDER
  The CANCELORDER command moves an Order into Canceled state. You can invoke the CancelOrder command for an Order that satisfies the following criteria:

• CASSETTECONTROL
  The CASSETTECONTROL command is used to perform cassette-specific functions that do not correspond to any generic commands. CASSETTECONTROL is not interpreted by the framework, but is passed down to the cassette.

• CLOSEORDER
  The CLOSEORDER command moves an Order into Closed state. You can invoke the CLOSEORDER command for an Order that satisfies the following criteria:

• CREATEACCOUNT
  The CREATEACCOUNT command creates an Account object for the specified Payment System object.

• CREATEMERCHANT
  The CREATEMERCHANT command creates a Merchant object.

• CREATEMERCHANTCASSETTEOBJECT
  The CREATEMERCHANTCASSETTEOBJECT command is used to create a cassette-specific object with the type specified in the OBJECTNAME keyword.

• CREATEMEREVENTLISTENER
  The CREATEMEREVENTLISTENER command creates a merchant event listener.

• CREATEPAYSYSTEM
  The CREATEPAYSYSTEM command creates a Payment System object for assigning the specified merchant permission to use the specified cassette.

• CREATESNMEVENTLISTENER
  The CREATESNMEVENTLISTENER command creates a system network management event listener.

• CREATESYSTEMCASSETTEOBJECT
  The CREATESYSTEMCASSETTEOBJECT command creates a cassette-specific object with the type specified in the OBJECTNAME keyword.

• DELETEACCOUNT
  The DELETEACCOUNT command deletes the specified Account object and all its subsidiary objects.

• DELETEBATCH
  The DELETEBATCH command prunes the specified batch from the database tables. The DELETEBATCH command is legal only when a batch is in Closed state.

• DELETEMERCHANT
  The DELETEMERCHANT command deletes the specified Merchant object and all its subsidiary objects.

• DELETEMERCHANTCASSETTEOBJECT
  The DELETEMERCHANTCASSETTEOBJECT command deletes the cassette object with the type specified by the object name.

• DELETEMEREVENTLISTENER
  The DELETEMEREVENTLISTENER command deletes the MerEventListener object.

• DELETEPAYSYSTEM
  The DELETEPAYSYSTEM command deletes the specified Payment System object and all its subsidiary objects.

• DELETESNMEVENTLISTENER
  The DELETESNMEVENTLISTENER command deletes the specified system network management event listener.

• DELETESYSTEMCASSETTEOBJECT
  The DELETESYSTEMCASSETTEOBJECT command deletes the Cassette object with type specified by object name.

• DEPOSIT
  The DEPOSIT command results in the association of a specified payment with a batch and the subsequent deposit of previously approved monies for that payment. The DEPOSIT command is legal when operating on deposits in Approved state.

• DEPOSITREVERSAL
  A DEPOSITREVERSAL command disassociates a payment from a batch. This command is legal for payments in Deposited state. If successful, the payment moves to Approved state or Void state, and the deposited amount is reset to "0".

• MODIFYACCOUNT
  The MODIFYACCOUNT command is used to change the attributes of a specified Account object.

• MODIFYCASSETTE
  The MODIFYCASSETTE command is used to modify the properties of the specified cassette object.

• MODIFYMERCHANT
  The MODIFYMERCHANT command modifies the properties of the specified Merchant object.

• MODIFYMERCHANTCASSETTEOBJECT
  The MODIFYMERCHANTCASSETTEOBJECT command modifies the properties of the Cassette object with type specified by the object name.

• MODIFYMEREVENTLISTENER
  The MODIFYMEREVENTLISTENER command modifies the specified MerEventListener object.

• MODIFYPAYSERVER
  The MODIFYPAYSERVER command modifies the global properties of the Payment Server object.

• MODIFYPAYSYSTEM
  The MODIFYPAYSYSTEM command modifies the specified Payment System object.

• MODIFYSNMEVENTLISTENER
  The MODIFYSNMEVENTLISTENER command modifies the System Network Management Event Listener object.

• MODIFYSYSTEMCASSETTEOBJECT
  The MODIFYSYSTEMCASSETTEOBJECT command modifies the properties of the Cassette object with the type specified by object name.

• MODIFYUSERSTATUS
  This command changes the status of the user who has the access rights to WebSphere Commerce Payments. Access control for this function is limited to the Payments Administrators and the Merchant Administrator. The Merchant Administrator can only "modify user status" of the user in his merchant.

• RECEIVEPAYMENT
  The RECEIVEPAYMENT command is used for order creation when there is electronic wallet participation. If successful, the order object is moved to Requested state. Subsequent wallet communication will complete the order and move it to Ordered state.

• REFUND
  A REFUND command is used to create a Credit object and is used when the merchant wants to return monies to the cardholder. The REFUND command is legal when the specified order is in Refundable state.

• REFUNDREVERSAL
  A REFUNDREVERSAL command is used to void existing Credit objects. This command operates on Credit objects in Refunded state. A successful REFUNDREVERSAL call will result in the Credit object moving to Void State. If unsuccessful, the Credit object remains in Refunded state.

• SETUSERACCESSRIGHTS
  The SETUSERACCESSRIGHTS command is used to set, change, or remove a user's access rights. However, this command will not create or remove users from the WCSRealm you are using to authenticate users. Before using the SetUserAccessRights command, make sure the user has been added to the WCSRealm.

• Query commands
  The following general rules apply to all queries:

• WebSphere Commerce Payments command reference
  For each WebSphere Commerce Payments application programming interface (API) command, the following sections describe:

• Cassette for BankServACH command reference
  For each WebSphere Commerce Payments application programming interface (API) command, the following sections describe:

Related reference

WebSphere Commerce Payments commands

+

Search Tips   |   Advanced Search