Open the Portico Developer Guide site
PosGateway Schema
IPTermsReqDataType Complex Type
PosGateway Schema : IPTermsReqDataType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
VISPlanOptions Element Program Element All IPTermsReqDataType Complex Type
Overview
All
Program programType Simple Type

Available to merchants in Asia Pacific, Mexico, and Canada.

For merchants in Canada, use VIS.

Valid values include:

  • mIPP
  • SIP
  • VIS

VISPlanOptions optional VISPlanOptionsType Complex Type

The VISOptions block includes filter criteria for installment plans requested from Visa Installments Service (VIS)

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
IPTerms Element
Source
<xs:complexType name="IPTermsReqDataType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="Program" type="ProgramType">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Available to merchants in Asia Pacific, Mexico, and Canada.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">For merchants in Canada, use VIS.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
              Valid values include:
              <ul><li>mIPP</li><li>SIP</li><li>VIS</li></ul></p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="VISPlanOptions" type="VISPlanOptionsType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The VISOptions block includes filter criteria for installment plans requested from Visa Installments Service (VIS)</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>
See Also
PosGateway Schema