RequiredPayment
For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.
Use the RequiredPayment pipeline component to verify that the payment authorization code exists in the order form (is not NULL).
Intended use: Order Processing pipeline, Payment stage.
Configuration Values
None.
Values Read
The RequiredPayment pipeline component reads the following values from the indicated dictionaries.
Key |
Dictionary |
Description |
|---|---|---|
_payment_auth_code |
Order |
The payment authorization code for the order form. |
MessageManager.pur_badpayment |
Context |
The error message text (optional). |
Values Written
The RequiredPayment pipeline component writes the following values to the Order dictionary.
Key |
Description |
|---|---|
_Purchase_Errors |
Error messages are written to this SimpleList object. |
Errors
The RequiredPayment pipeline component writes an error message to the _Purchase_Errors collection. The component uses a MessageManager object to retrieve user warning message text.
Constant |
Condition |
|---|---|
pur_badpayment |
The payment authorization code is missing from the order form. |
Remarks
If the payment authorization code does not exist (is equal to NULL), the RequiredPayment pipeline component retrieves the error for the pur_badpayment constant from the MessageManager object, and writes this error to the _Purchase_Errors collection of the Order dictionary.