Canada

For merchants in Canada processing on the GSAP-NA authorization platform, installment payments are supported through Visa Installment Service (VIS). Visa Installments Service supports Visa cards. Eligibility depends on the card issuing bank's participation in VIS. Merchant enrollment in VIS is required.

NOTE: Guidance on displaying installment plan details, design requirements and marketing guidelines are available from the Global Payments website. Please contact your representative for additional insights or questions.

Requesting Eligible Plans with VIS - Credit IP Query Request

CreditIPQuery is used to obtain a list of plans from VIS for the card and amount provided. Optional filters for the plans may also be included in the request.

Within the IPTerms data block, the following fields are provided:

Subfield	Required/Optional	Description
Program	Required	Always VIS
ReturnAllEligiblePlans	Optional	VIS guidelines recommend presenting two installment plans to a customer, as well as the full purchase price. By default returned plans are limited to only two, as determined by VIS. If this field is set to true in the CreditIPQuery request, the response will contain all available plans options. The merchant POS system can manage the options presented to the cardholder.
PlanType	Conditional	Indicates whether the plans should be Customer Funded or Merchant Funded When not specified, either type may be returned.
MaxTermMonths	Optional	Required when PlanType is MERCHANT_FUNDED. The maximum number of months for the requested plan options.
AmountThreshold	Optional	This option is used in conjunction with the transaction amount, to determine whether the plans are returned in the order of longest or shortest duration. As the default option is to only return two plans, if more eligible plans are available this may affect the plans that are returned. When Amt is greater than (>) AmountThreshold, plans are returned in order of longest duration When Amt is less than (>) AmountThreshold, plans are returned in order of shortest duration NOTE: While Amt is a decimal value, AmountThreshold is an integer value with an implied decimal, based on local currency.

Receiving Eligible Plans with VIS - Credit IP Query Response

The VISEligiblePlans data block within the response contains plan information returned by VIS.

Subfield	Description
Program	The installment payments program type. This value is echoed from the request.
VISEligiblePlans	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. The default is 2 plans; if the request contained ReturnAllEligiblePlans as true, then all eligible will be returned as determined by VIS.
EligiblePlans	VIS installment plan information returned by VIS. Certain sub-elements may be repeated.
PlanName	The name of installment plan
PlanType	The type of installment plan
NbrOfInstallments	The number of installments for the plan.
TermsConditions	Contains the Plan Terms and Conditions to be presented to the customer. This data block may iterate multiple times within each returned plan, based on available versions and languages for the plan.
FeeInfo	The fee information for the installment plan. This data block may iterate multiple times within each returned plan, depending on the number of fee types and options available for the plan.

When no eligible plans are available for the requested PAN and amount, the CreditIPQuery response will return a decline with a response message indicating that no plans were received. The VISEligiblePlans data block is not included in the response.

NOTE: Amount values within the EligiblePlans data block are returned from VIS as integers, with an implied decimal based on the merchant's local currency.

Displaying Options to the Cardholder

Refer to the Visa Installments UX Guide linked on the Global Payments website for detailed interface requirements when presenting installment plans to customers during the purchase process. The following table indicates how the data elements in the EligblePlans block of the CreditIPQuery response correspond to each element of the customer-facing interface:

User Interface Element	Portico Response Field
Number of Installments	NbrOfInstallments
Installment Frequency	InstallmentFrequency
Installment Payment Amount	Calculated sum of: CostInfo.FirstInstallment.InstallmentFee + CostInfo.FirstInstallment.UpfrontFee + CostInfo.FirstInstallment.Amount Displayed with: CostInfo.Currency NOTE: Amounts are returned by VIS as integer values and should be displayed with minor units based on Currency. For example: Amount "10800" with Currency "CAD" would be displayed as "$108.00" to the cardholder.
Total Amount, inclusive of fees	CostInfo.TotalPlanCost
Terms and Conditions	TermsConditions.Text
Hyperlinked URL	TermsConditions.Url

Confirming a Plan Choice with VIS - Credit Authorization Request

After the cardholder selects the program and completes the sale, the IPSelectedTerms data block is included in a CreditAuth or CreditSale to indicate the Installment Plan terms selected by the cardholder.

The authorization request is received by the issuer and associated to the installment plan with VIS.

The IPSelectedTerms data block in the authorization request supports multiple installment payment programs. For VIS the following fields are applicable:

Subfield	Required/Optional	Description
PlanId	Required	The ID for the installment plan selected by the customer
TermsConditionVersion	Required	The Version of the TermsConditions used for the selected plan
TermsConditionLanguage	Required	The language of the TermsConditions used for the selected plan

NOTE: When completing an authorization with CreditAddToBatch, the gateway will not submit an authorization or reversal when the settlement amount of a transaction is altered. The Point of Sale is responsible for managing these adjustments as needed.

Installment Cancellation VIS - Credit Void or Reversal Request

A CreditVoid or a CreditReversal may be processed against a prior CreditAuth or CreditSale approved with an installment plan.

CreditReversal may request cancellation for either a partial or full amount. CreditVoid cancels the plan in full.

Partial and full installment plan cancellations cannot be reverted once approved. If the plan amount is reduced in error, the plan should be cancelled and a new installment plan should be established with the cardholder.

Purchase Returns with VIS - Credit Return Request

A CreditReturn may be processed against a prior CreditAuth or CreditSale approved with an installment plan. To ensure the customer's installment plan is updated appropriately, the request must not be a blind return and must include either the GatewayTxnId or the Global Transaction Id that identifies the original authorization.

CreditReturn may request cancellation for either a partial or full amount.

Partial and full installment plan cancellations cannot be reverted once approved. If any additional change to the amount is needed, the plan should be refunded in full and a new installment plan should be established with the cardholder.