Open the Portico Developer Guide site
PosGateway Schema
MatchedPlansType Complex Type
PosGateway Schema : MatchedPlansType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
PlanId Element CostInfo Element TermsConditions Element InstallmentFrequency Element NbrOfInstallments Element PlanType Element PlanName Element Sequence MatchedPlansType Complex Type
Overview
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.

All
Url optional xs:string

The display URL for the plan terms and conditions

Version optional xs:string

The version of the plan terms and conditions

Text optional xs:string

The text of the plan terms and conditions

LanguageCode optional xs:string

The language of plan terms and conditions

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.

Sequence
AnnualPercentageRate optional xs:decimal

The APR for the installment plan

FeeInfo 0..∞ FeeInfoType Complex Type

The fee information for the installment plan.

All
Type optional xs:string

The fee type

RatePercentage optional xs:decimal

The rate percentage

FlatFee optional xs:int

Flat fee

TotalPlanCost optional xs:int

The total cost of the installment plan

TotalFees optional xs:int

The total fees for the installment plan

TotalUpfrontFees optional xs:int

The total upfront fees for the installment plan

TotalRecurringFees optional xs:int

The total recurring fees for the installment plan

FirstInstallment optional FirstInstallmentType Complex Type

The first installment fee information for the installment plan

All
UpfrontFee optional xs:int

Upfront fee

InstallmentFee optional xs:int

Installment fee

Amount optional xs:int

Installment amount

LastInstallment optional LastInstallmentType Complex Type

The last installment fee information for the installment plan

All
InstallmentFee optional xs:int

Last Installment fee

Amount optional xs:int

Last installment amount

Currency optional xs:string

The currency type associated with the installment plan

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

Used By
EligiblePlans Element
Source
<xs:complexType name="MatchedPlansType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element name="PlanName" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The name of the Installment Plan</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PlanType" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The type of installment plan</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="NbrOfInstallments" type="xs:int" minOccurs="0" default="-1">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The number of installments for the plan</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="InstallmentFrequency" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The frequency of installments for the plan</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TermsConditions" type="TermsConditionsType" minOccurs="0" maxOccurs="unbounded">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains the Plan Terms and Conditions to be presented to the customer. This element may be repeated when multiple Terms and Conditions are available.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="CostInfo" type="CostInfoType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Contains information related to costs and fees associated with the Installment Plan. This element may be repeated when multiple cost options are available.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PlanId" type="xs:string" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">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</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:sequence>
</xs:complexType>
See Also
PosGateway Schema