PIRemove URL

This URL removes one or more existing payment instructions from an order.

URL

PIRemove

Controller command

PIRemoveCmd

Implementation class

PIRemoveCmdImpl

Commands called

EditCmd

URL structure

http://host_name/path/

The fully qualified name of the 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/PIRemove?orderId=112233
     &piId=27022&piId=27023&URL=/

Behavior

Check if the order is locked by the current CSR. If the order is not locked and called by a CSR, or if it is locked by another CSR, an exception is thrown

Call EditCmd (EDP command) to edit the payment instruction

Examine the result of EditCmd and throw exception if the result is null or if there is an error in the results

Exception conditions

None.

Related concepts
Payment instructions
Payment methods

Related reference
PIAdd URL
PICopy URL
PIEdit URL