VISPlanOptionsType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

VISPlanOptionsType

All

ReturnAllEligiblePlans optional xs:boolean

By default only two eligible plans are returned for the VIS Program. When sent as True all eligble plans are returned, and the merchant may choose which plans to present to the customer.

PlanType optional PlanOptionType Simple Type

Indicates whether the installment plans returned should be Customer Funded or Merchant Funded.

Valid values include:

MERCHANT_FUNDED
CONSUMER_FUNDED
ANY

MaxTermMonths optional xs:int

Sets the maximum number of months for the installment plan. Used only when PlanType is MERCHANT_FUNDED.

AmountThreshold optional xs:int

Compared to the Amt value and used to determine whether installment plans are returned in the order of the longest duration (Amt is greater than or equal to AmountThreshold) or shortest duration (Amt is less than AmountThreshold).

Note: While the Amt element value is sent as a decimal (e.g. 100.00), the AmountThreshold element is an integer value with an implied decimal position based on local currency (e.g. 10000).

Used By

VISPlanOptions Element

Source

<xs:complexType name="VISPlanOptionsType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="ReturnAllEligiblePlans" type="xs:boolean" minOccurs="0" default="false">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">By default only two eligible plans are returned for the VIS Program. When sent as True all eligble plans are returned, and the merchant may choose which plans to present to the customer.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PlanType" type="PlanOptionType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">
              Indicates whether the installment plans returned should be Customer Funded or Merchant Funded.
            </p>
          <p xmlns="http://Hps.Exchange.PosGateway">
              Valid values include:
              <ul><li>MERCHANT_FUNDED</li><li>CONSUMER_FUNDED</li><li>ANY</li></ul></p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="MaxTermMonths" type="xs:int" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Sets the maximum number of months for the installment plan. Used only when PlanType is MERCHANT_FUNDED.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="AmountThreshold" type="xs:int" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Compared to the Amt value and used to determine whether installment plans are returned in the order of the longest duration (Amt is greater than or equal to AmountThreshold) or shortest duration (Amt is less than AmountThreshold).</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Note: While the Amt element value is sent as a decimal (e.g. 100.00), the AmountThreshold element is an integer value with an implied decimal position based on local currency (e.g. 10000).</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>