Open the Portico Developer Guide site
PosGateway Schema
IPSelectedTerms Element
PosGateway Schema > CreditSaleReqBlock1Type Complex Type : IPSelectedTerms 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 must provide the Program and VISOptions.

For Visa Installment Service (VIS) merchants must provide VISPlanOptions and Program.

Namespace http://Hps.Exchange.PosGateway
Type
IPSelectedTermsReqType Complex Type
Diagram
TermsConditionLanguage Element TermsConditionVersion Element PlanId Element NbrInstallments Element GracePeriod Element InstallmentPlan Element SIPOptions Element Program Element All IPSelectedTerms Element
Overview
IPSelectedTerms optional IPSelectedTermsReqType 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 must provide the Program and VISOptions.

For Visa Installment Service (VIS) merchants must provide VISPlanOptions and Program.

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

Source
<xs:element name="IPSelectedTerms" type="IPSelectedTermsReqType" 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 must provide the Program and VISOptions.</p>
      <p xmlns="http://Hps.Exchange.PosGateway">For Visa Installment Service (VIS) merchants must provide VISPlanOptions and Program.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>
See Also
CreditSaleReqBlock1Type Complex TypePosGateway Schema