IPTerms Element

Description

The IPTerms block include information regarding the installment Program.

For Visa Installments Service (VIS), multiple plans are returned in the response. The VISOptions block includes additional filter options for the returned plans.

Namespace

http://Hps.Exchange.PosGateway

Type

IPTermsReqDataType Complex Type

Diagram

Overview

IPTerms optional IPTermsReqDataType Complex Type

The IPTerms block include information regarding the installment Program.

For Visa Installments Service (VIS), multiple plans are returned in the response. The VISOptions block includes additional filter options for the returned plans.

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).

Source

<xs:element name="IPTerms" type="IPTermsReqDataType" minOccurs="0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">The IPTerms block include information regarding the installment Program.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">For Visa Installments Service (VIS), multiple plans are returned in the response. The VISOptions block includes additional filter options for the returned plans.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>