Commerce Foundation Payment
This Commerce Server 2009 commerce entity represents a payment applied or to apply (depending on BasketType) to a basket. It contains the amount applied, a related account from which to collect, and a status code explaining the state of the payment.
Model
This commerce entity can be modified, as required. This model, taken from the out-of-the-box site, is provided as an example.
<CommerceEntity name="Payment">
<Properties>
<Property name="Id" dataType="String">
<DisplayName value="Id"/>
<Description value="Unique ID of the payment." />
</Property>
<Property name="Amount" dataType="Decimal">
<DisplayName value="Amount"/>
<Description value="The payment amount." />
</Property>
<Property name="Status" dataType="String">
<DisplayName value="Status"/>
<Description value="The payment status." />
</Property>
</Properties>
</CommerceEntity>
Properties
Property |
Type |
Description |
|---|---|---|
Amount |
decimal |
Amount paid. |
Status |
String |
Status code resulting from the processing of the payment.
StatusDescription
Pending Indicates that payment was submitted but not approved yet.
Accepted Indicates that payment was accepted. The system may supply a localized StatusMessage.
TemporaryError Indicates that the payment processor experienced an internal problem, no funds were collected, and the client should try again later.
InvalidIndicates that the client supplied account information that is not valid and payment could not proceed.
InsufficientFundsIndicates that the payment processor reported an insufficient amount of funds to cover the payment.
|
Id |
String |
Unique identifier of the commerce entity. |
Relationships
Property |
Description |
|---|---|
PaymentAccount |
The account for the current payment. |
Supported Operations
Commerce Foundation Basket CommerceQuery
Commerce Foundation Basket CommerceUpdate