Open the Portico Developer Guide site
PosGateway Schema
IpTerms Element
PosGateway Schema > AuthRspStatusType Complex Type : IpTerms Element
Description

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

Namespace http://Hps.Exchange.PosGateway
Type
IPTermsRspDataType Complex Type
Diagram
VISEligiblePlans Element TermOptions Element Program Element All IpTerms Element
Overview
IpTerms optional IPTermsRspDataType Complex Type

Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:

Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.

Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.

Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.

All
Program programType Simple Type

The installment payments program type. This value is echoed from the request.

TermOptions optional TermOptionsType Simple Type

Term Options, only returned for the mIPP or SIP Programs.

The format is based by the Program.

VISEligiblePlans optional

This block provides information regarding eligible Visa Installment Service (VIS) installment plans, to be presented to the cardholder (EligiblePlans).

When the CardNbr and Amt are eligible, VIS returns 2 to n installment plans. Multiple plans are returned in the response.

When the CardNbr and Amt are not eligible, VIS returns a success response but EligiblePlans will be empty.

Choice 0..∞
EligiblePlans MatchedPlansType Complex Type

VIS installment plan information returned by VIS. Certain sub-elements may be repeated.

Sequence
PlanName optional xs:string

The name of the Installment Plan

PlanType optional xs:string

The type of installment plan

NbrOfInstallments optional xs:int

The number of installments for the plan

InstallmentFrequency optional xs:string

The frequency of installments for the plan

TermsConditions 0..∞ TermsConditionsType Complex Type

Contains the Plan Terms and Conditions to be presented to the customer. This element may be repeated when multiple Terms and Conditions are available.

CostInfo optional CostInfoType Complex Type

Contains information related to costs and fees associated with the Installment Plan. This element may be repeated when multiple cost options are available.

PlanId optional xs:string

The reference ID for the Installment Plan, as provided by VIS. This is the reference ID for the plan chosen by the customer, and used in all subsequent transactions

Source
<xs:element name="IpTerms" type="IPTermsRspDataType" minOccurs="0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">Information on the Installment Plan chosen by the customer. Usage varies by region and the Installments service provider:</p>
      <p xmlns="http://Hps.Exchange.PosGateway">Merchants located in the Asia Pacific region must provide the NbrInstallments and Program. SIPOptions is optional.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">Merchants located in Mexico must provide the NbrInstallemnts, InstallmentPlan, and GracePeriod only.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">Merchants located in Canada using Visa Installment Service (VIS) must provide the Program and VISOptions.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>
See Also
AuthRspStatusType Complex TypePosGateway Schema