Open the Portico Developer Guide site
PosGateway Schema
IPSelectedTermsReqType Complex Type
PosGateway Schema : IPSelectedTermsReqType Complex Type
Namespace http://Hps.Exchange.PosGateway
Diagram
TermsConditionLanguage Element TermsConditionVersion Element PlanId Element NbrInstallments Element GracePeriod Element InstallmentPlan Element SIPOptions Element Program Element All IPSelectedTermsReqType Complex Type
Overview
All
Program optional programType Simple Type

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

For merchants in Canada, use VIS.

Valid values include:

  • HSBCIPP
  • mIPP
  • SIP
  • VIS

SIPOptions optional sipOptionsType Simple Type

Available to merchants in Asia Pacific. Required when the Program is SIP

Valid values include:

  • 01 - SIPZERO
  • 02 - SIPREGULAR
  • 03 - SIPMADNESS

InstallmentPlan optional installmentPlanType Simple Type

Required for merchants in Mexico

Valid values include:

  • 00 - No promotion
  • 03 - Without interest to the cardholder
  • 05 - With interest to the cardholder
  • 07 - Buy today, pay later

GracePeriod optional gracePeriodType Simple Type

The grace period before the first payment. 00 indicates no grace period

Required for merchants in Mexico

NbrInstallments optional nbrInstallmentsType Simple Type

The total number of installments

This field is available to merchants in Asia Pacific and merchants in Mexico

PlanId optional planIdReqType Simple Type

The PlanId of the customer's selected VIS installment plan

Required when the Program is VIS

TermsConditionVersion optional termsConditionVersionReqType Simple Type

The Terms and Conditions version the customer's selected VIS installment plan

Required when the Program is VIS

TermsConditionLanguage optional termsConditionLanguageReqType Simple Type

The Language Code the customer's selected VIS installment plan

Required when the Program is VIS

Used By
IPSelectedTerms Element
IPSelectedTerms Element
IPSelectedTerms Element
Source
<xs:complexType name="IPSelectedTermsReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="Program" type="programType" minOccurs="0">
      <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>HSBCIPP</li><li>mIPP</li><li>SIP</li><li>VIS</li></ul></p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SIPOptions" type="sipOptionsType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Available to merchants in Asia Pacific. Required when the Program is SIP</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
              Valid values include:
              <ul><li>01 - SIPZERO</li><li>02 - SIPREGULAR</li><li>03 - SIPMADNESS</li></ul></p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="InstallmentPlan" type="installmentPlanType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Required for merchants in Mexico</p>
          <p xmlns="http://Hps.Exchange.PosGateway">
              Valid values include:
              <ul><li>00 - No promotion</li><li>03 - Without interest to the cardholder</li><li>05 - With interest to the cardholder</li><li>07 - Buy today, pay later</li></ul></p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="GracePeriod" type="gracePeriodType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The grace period before the first payment. 00 indicates no grace period</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Required for merchants in Mexico</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="NbrInstallments" type="nbrInstallmentsType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The total number of installments</p>
          <p xmlns="http://Hps.Exchange.PosGateway">This field is available to merchants in Asia Pacific and merchants in Mexico</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="PlanId" type="planIdReqType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The PlanId of the customer's selected VIS installment plan</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Required when the Program is VIS</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TermsConditionVersion" type="termsConditionVersionReqType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The Terms and Conditions version the customer's selected VIS installment plan</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Required when the Program is VIS</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TermsConditionLanguage" type="termsConditionLanguageReqType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The Language Code the customer's selected VIS installment plan</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Required when the Program is VIS</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>
See Also
PosGateway Schema