PIRemove URL
This URL removes one or more existing payment instructions from an order.
URL structure
- http://host_name/path/
- The fully qualified name of your WebSphere Commerce Server and the configuration path.
Parameter values
- orderId
- (Required) The identifier of the order to which the payment instruction is to be removed.
- URL
- (Required) The URL to be called when the command completes successfully.
- piId
- (Required) The numeric identifier (big integer) of the payment instruction to remove. The piId can be obtained from the EDPPaymentInstructionsDataBean data bean and represents the combination of the payment method, payment amount, and any protocol data. This parameter can be repeated if there are more payment instructions to be removed in this request.
- errorViewName
- The view name which is redirected to when the execution fails. If this parameter is provided, the default error view name is PaymentInstructionErrorView.
Example
The following example removes two payment instructions from order 112233.
http://host_name/webapp/wcs/stores/servlet/PIAdd?orderID=112233
&piId=27022&piId=27023&URL=/
Behavior
Removes a payment instruction for an existing order:
- Validates that the orderId, at least one piId, and a URL are passed as parameters.
- Validates that an order exists for the orderId.
- Creates an EDPPaymentInstruction for each PI to be removed with the ID to cancel attribute settings, and adds it to a list of PIs to delete.
- Calls the EditCmd task command with the orderId, the list of PIs to delete, and the total order amount.
- Checks the results from the task command and redirects to an error view. Otherwise, it redirects to the URL that was passed as a parameter.
Exception conditions
None.
(C) Copyright IBM Corporation 1996, 2006. All Rights Reserved.