Commerce Foundation PaymentMethod

This Commerce Server 2009 commerce entity represents one the methods of payment that the deployed system supports.

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="PaymentMethod">
    <Properties>
      <Property name="Id" dataType="String">
        <DisplayName value="Id"/>
        <Description value="Unique ID of the payment method." />
      </Property>
      <Property name="DisplayName" dataType="String">
        <DisplayName value="Display Name"/>
        <Description value="The payment method display name." />
      </Property>
      <Property name="Description" dataType="String">
        <DisplayName value="Description"/>
        <Description value="The payment method description." />
      </Property>
      <Property name="PaymentType" dataType="Integer">
        <DisplayName value="Payment Type"/>
        <Description value="The type of the payment method." />
        <EnumeratedValues>
          <EnumerationEntry value ="0">
        <DisplayName value="None" />
          </EnumerationEntry>
          <EnumerationEntry value ="1">
        <DisplayName value="CreditCard" />
          </EnumerationEntry>
          <EnumerationEntry value ="2">
        <DisplayName value="GiftCertificate" />
          </EnumerationEntry>
          <EnumerationEntry value ="3">
        <DisplayName value="PurchaseOrder" />
          </EnumerationEntry>
          <EnumerationEntry value ="4">
        <DisplayName value="CashCard" />
          </EnumerationEntry>
          <EnumerationEntry value ="5">
        <DisplayName value="Custom" />
          </EnumerationEntry>
          <EnumerationEntry value ="6">
        <DisplayName value="Custom1" />
          </EnumerationEntry>
          <EnumerationEntry value ="7">
        <DisplayName value="Custom2" />
          </EnumerationEntry>
          <EnumerationEntry value ="8">
        <DisplayName value="Custom3" />
          </EnumerationEntry>
          <EnumerationEntry value ="9">
        <DisplayName value="Custom4" />
          </EnumerationEntry>
          <EnumerationEntry value ="10">
        <DisplayName value="Custom5" />
          </EnumerationEntry>
        </EnumeratedValues>
      </Property>
    </Properties>
</CommerceEntity>

Properties

Property	Type	Description
Description	String	Optional localized description of the payment method.
DisplayName	String	Localized display name of the payment method.
Id	String	Unique identifier of the commerce entity.
PaymentType	int?	Generic type of this payment. This represents a high-level typing or categorization for payment methods. You use the values 5 (Custom) to 10 (Custom5) to group additional types of payment methods into six categories not covered by the four specific ones. For example, 5 may represent "Direct Payment" payment methods while 6 may represent "Web-based" payment methods. 0 - None . No payment type. For more information on Payment Types see Orders Objects.

Relationships

None.

Supported Operations

The payment method commerce entity supports the following operations:

Commerce Foundation Basket CommerceUpdate

Commerce Foundation PaymentMethod CommerceQuery

See Also

Other Resources

Developing with the Commerce Foundation Orders System

Commerce Foundation Payment

Commerce Foundation PaymentMethod CommerceQuery