Visa Installments

To learn more about Visa Installments, please check the following link

Before initiating the payment request you need to get the information about eligible installment plans. For this purpose you have to send an action request via SOAP API.

The following parameters are required to be passed to the Gateway:

Field name	M/O	Description
`StoreId`	M	The store ID for which the eligibility call is initiated.
`CardNumber`	C	If clear card number is used
`HostedDataId`	C	If the eligibility check should be handled for a token linked to a card.
`CryptData...`	C	If eligibility call is initiated from POS, card data must be send as described in https://docs.fiserv.dev/public/docs/soap-api-emv-appendix
`Amount`	M	Amount for which the eligibility call is initiated.
`Currency`	M	Currency of the card for which the eligibility call is initiated.

The following XML message represents an example of an action request with minimum set of elements:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <ns4:IPGApiActionRequest xmlns:ns4="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ns3="http://ipg-online.com/ipgapi/schemas/v1">
         <ns2:Action>
            <ns2:GetEligibleInstallmentPlans>
               <ns2:StoreId>1234567890</ns2:StoreId>
               <ns2:CardNumber>476134xxx7021117</ns2:CardNumber>
               <ns2:Amount>4556</ns2:Amount>
               <ns2:Currency>SGD</ns2:Currency>
            </ns2:GetEligibleInstallmentPlans>
         </ns2:Action>
      </ns4:IPGApiActionRequest>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

If the transaction is eligible for Visa installments, then 1 or more installment plan options are included in the API response:

Field name	Presence	Description
`InstallmentPlanInquiryId`	M	Contains plan ID generated by the Gateway.
`InstallmentPlanId`	M	This objects contains the reference to the installment plan defined by Visa.
`Provider`	M	Service provider of the individual installment plan
`Tenure`	M	Number of installments of the individual installment plan
`InterestRate`	M	Interest rate of the individual installment plan
`Currency`	M	3-digit ISO Alpha code currency code of the individual installment plan
`InstallmentFee`	M	Processing fee by the Issuer
`totalFee`	M	This is the complete set of Fees, which includes, recurring fees, processing fees, upfront fees etc.
`TotalAmount`	M	Total amount payable by the customer for the product purchased, including the interest and other fees along with the principal
`AmountPerMonth`	M	The complete amount per month the customer will have to pay, including the fees and other charges
`termsAndConditionText`	C	Terms and conditions to be displayed and acknowledged by the customer. Not present in APAC region.
`TermsAndConditionVersion`	C	Related version of the terms and conditions. Not present in APAC region.
`AdditionalTermsAndConditionsURL`	C	Additional terms and conditions to be displayed and acknowledged by the customer. Not present in APAC region.
`LanguageCode`	C	Language of terms and conditions
`ProductCode`	C	Bank defined product code. Only applicable for APAC region.
`ProgramCode`	C	Bank defined program code. Only applicable for APAC region.
`BankName`	C	Available bank name for respective BIN. Only present for specific banks in APAC region.
`BankCode`	C	Available bank code for respective BIN. Only present for specific banks in APAC region.
`InstallmentMerchantId`	C	Only present for specific banks in APAC with multi MID setup for installments.
`InstallmentTerminalId`	C	Only present for specific banks in APAC with multi MID setup for installments.

The following XML message represents an example of the response:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <ipgapi:IPGApiActionResponse xmlns:a1="http://ipg-online.com/ipgapi/schemas/a1" xmlns:ipgapi="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1">
         <ipgapi:successfully>true</ipgapi:successfully>
         <a1:EligibleInstallmentPlanResponse>
            <a1:InstallmentPlan>
               <v1:InstallmentPlanId>6aba19b5-4bf8-72fe-4bd6-19ccea7fd302</v1:InstallmentPlanId>
               <v1:InstallmentPlanIdReference>00000000OV</v1:InstallmentPlanIdReference>
               <v1:Provider>VIS</v1:Provider>
               <v1:Tenure>3</v1:Tenure>
               <v1:InterestRate>0</v1:InterestRate>
               <v1:Currency>SGD</v1:Currency>
               <v1:InstallmentFee>0.00</v1:InstallmentFee>
               <v1:TotalFee>0.00</v1:TotalFee>
               <v1:AmountPerMonth>1518.67</v1:AmountPerMonth>
               <v1:TotalAmount>4556.00</v1:TotalAmount>
               <v1:TermsAndConditionText>I confirm I have read and agreed to the terms and conditions for this instalment plan at the links below and I consent to the collection, processing and disclosure of my information to HSBC Bank Malaysia Berhad or HSBC Amanah Malaysia Berhad for the purpose of this transaction. HSBC Credit Card - Terms and Conditions : <a href ="https://hsbc.com.my/iptc"Target=_blank" >https://hsbc.com.my/iptc</a> HSBC Amanah Credit Card - Terms and Conditions: <a href ="https://hsbcamanah.com.my/iptc"Target=_blank" >https://hsbcamanah.com.my/iptc</a></v1:TermsAndConditionText>
               <v1:AdditionalTermsAndConditionsURL>https://hsbc.com.my/iptc</v1:AdditionalTermsAndConditionsURL>
               <v1:TermsAndConditionVersion>3</v1:TermsAndConditionVersion>
               <v1:InstallmentMerchantId>290070259330638</v1:InstallmentMerchantId>
               <v1:InstallmentTerminalId>19024144</v1:InstallmentTerminalId>
               <v1:LanguageCode>eng</v1:LanguageCode>
               <v1:Bank>
                  <v1:BankName>Visa Instalment program</v1:BankName>
                  <v1:BankCode>004</v1:BankCode>
               </v1:Bank>
            </a1:InstallmentPlan>
            <a1:InstallmentPlan>
               <v1:InstallmentPlanId>206132b7-a6d8-62dc-b3ff-11664fc97002</v1:InstallmentPlanId>
               <v1:InstallmentPlanIdReference>00000000OW</v1:InstallmentPlanIdReference>
               <v1:Provider>VIS</v1:Provider>
               <v1:Tenure>6</v1:Tenure>
               <v1:InterestRate>0</v1:InterestRate>
               <v1:Currency>SGD</v1:Currency>
               <v1:InstallmentFee>0.00</v1:InstallmentFee>
               <v1:TotalFee>0.00</v1:TotalFee>
               <v1:AmountPerMonth>759.34</v1:AmountPerMonth>
               <v1:TotalAmount>4556.00</v1:TotalAmount>
               <v1:TermsAndConditionText>I read and agreed to the terms and conditions for this instalment plan. Credit Card Terms and Conditions: <a href ="https://sg.issuingbank.com/microsites/newipp/files/Card_Instalment_Plan_TnC.pdf"Target=_blank" >https://sg.issuingbank.com/microsites/newipp/files/Card_Instalment_Plan_TnC.pdf</a></v1:TermsAndConditionText>
               <v1:AdditionalTermsAndConditionsURL>https://sg.issuingbank.com</v1:AdditionalTermsAndConditionsURL>
               <v1:TermsAndConditionVersion>2</v1:TermsAndConditionVersion>
               <v1:InstallmentMerchantId>290070259330638</v1:InstallmentMerchantId>
               <v1:InstallmentTerminalId>19024144</v1:InstallmentTerminalId>
               <v1:LanguageCode>eng</v1:LanguageCode>
               <v1:Bank>
                  <v1:BankName>Visa Instalment program</v1:BankName>
                  <v1:BankCode>004</v1:BankCode>
               </v1:Bank>
            </a1:InstallmentPlan>
            <a1:InstallmentPlan>
               <v1:InstallmentPlanId>73aa6110-20e8-462e-290f-18548cf2d502</v1:InstallmentPlanId>
               <v1:InstallmentPlanIdReference>00000000OY</v1:InstallmentPlanIdReference>
               <v1:Provider>VIS</v1:Provider>
               <v1:Tenure>12</v1:Tenure>
               <v1:InterestRate>0</v1:InterestRate>
               <v1:Currency>SGD</v1:Currency>
               <v1:InstallmentFee>0.00</v1:InstallmentFee>
               <v1:TotalFee>0.00</v1:TotalFee>
               <v1:AmountPerMonth>379.67</v1:AmountPerMonth>
               <v1:TotalAmount>4556.00</v1:TotalAmount>
               <v1:TermsAndConditionText>read and agreed to the terms and conditions for this instalment plan. Credit Card Terms and Conditions: <a href ="https://sg.issuingbank.com/microsites/newipp/files/Card_Instalment_Plan_TnC.pdf"Target=_blank" >https://sg.issuingbank.com/microsites/newipp/files/Card_Instalment_Plan_TnC.pdf</a></v1:TermsAndConditionText>               <v1:AdditionalTermsAndConditionsURL>https://sg.issuingbank.com</v1:AdditionalTermsAndConditionsURL>
               <v1:TermsAndConditionVersion>2</v1:TermsAndConditionVersion>
               <v1:InstallmentMerchantId>290070259330638</v1:InstallmentMerchantId>
               <v1:InstallmentTerminalId>19024144</v1:InstallmentTerminalId>
               <v1:LanguageCode>eng</v1:LanguageCode>
               <v1:Bank>
                  <v1:BankName>Visa Instalment program</v1:BankName>
                  <v1:BankCode>004</v1:BankCode>
               </v1:Bank>
            </a1:InstallmentPlan>
            <a1:InstallmentPlan>
               <v1:InstallmentPlanId>dab6a4e8-d9b6-43dd-ff85-1ff80903bd01</v1:InstallmentPlanId>
               <v1:InstallmentPlanIdReference>00000000TT</v1:InstallmentPlanIdReference>
               <v1:Provider>VIS</v1:Provider>
               <v1:Tenure>24</v1:Tenure>
               <v1:InterestRate>0</v1:InterestRate>
               <v1:Currency>SGD</v1:Currency>
               <v1:InstallmentFee>0.00</v1:InstallmentFee>
               <v1:TotalFee>0.00</v1:TotalFee>
               <v1:AmountPerMonth>189.84</v1:AmountPerMonth>
               <v1:TotalAmount>4556.00</v1:TotalAmount>
               <v1:TermsAndConditionText>test</v1:TermsAndConditionText>
               <v1:AdditionalTermsAndConditionsURL/>
               <v1:TermsAndConditionVersion>1</v1:TermsAndConditionVersion>
               <v1:InstallmentMerchantId>290070259330638</v1:InstallmentMerchantId>
               <v1:InstallmentTerminalId>19024144</v1:InstallmentTerminalId>
               <v1:LanguageCode>eng</v1:LanguageCode>
               <v1:Bank>
                  <v1:BankName>Visa Instalment program</v1:BankName>
                  <v1:BankCode>004</v1:BankCode>
               </v1:Bank>
            </a1:InstallmentPlan>
            <a1:InstallmentPlan>
               <v1:InstallmentPlanId>d885a1aa-a9eb-fa86-412e-1c52bf97ab01</v1:InstallmentPlanId>
               <v1:InstallmentPlanIdReference>00000000TU</v1:InstallmentPlanIdReference>
               <v1:Provider>VIS</v1:Provider>
               <v1:Tenure>36</v1:Tenure>
               <v1:InterestRate>0</v1:InterestRate>
               <v1:Currency>SGD</v1:Currency>
               <v1:InstallmentFee>0.00</v1:InstallmentFee>
               <v1:TotalFee>0.00</v1:TotalFee>
               <v1:AmountPerMonth>126.56</v1:AmountPerMonth>
               <v1:TotalAmount>4556.00</v1:TotalAmount>
               <v1:TermsAndConditionText>test</v1:TermsAndConditionText>
               <v1:AdditionalTermsAndConditionsURL/>
               <v1:TermsAndConditionVersion>1</v1:TermsAndConditionVersion>
               <v1:InstallmentMerchantId>290070259330638</v1:InstallmentMerchantId>
               <v1:InstallmentTerminalId>19024144</v1:InstallmentTerminalId>
               <v1:LanguageCode>eng</v1:LanguageCode>
               <v1:Bank>
                  <v1:BankName>Visa Instalment program</v1:BankName>
                  <v1:BankCode>004</v1:BankCode>
               </v1:Bank>
            </a1:InstallmentPlan>
         </a1:EligibleInstallmentPlanResponse>
      </ipgapi:IPGApiActionResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Once you have received the eligible installment plans from the Gateway, you can display the list of plans to the cardholder.

If the cardholder makes a selection of one installment option, then you have to include the selected plan into the API request to the Gateway. Otherwise, you do not need to include any installment relevant information into the payment request.

The following XML message represents an example of a API request with a selected installment plan:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ipg="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:v1="http://ipg-online.com/ipgapi/schemas/v1" xmlns:pay="http://api.clickandbuy.com/webservices/pay_1_0_0/">
   <soapenv:Header/>
   <soapenv:Body>
      <ns4:IPGApiOrderRequest xmlns:ns4="http://ipg-online.com/ipgapi/schemas/ipgapi" xmlns:ns2="http://ipg-online.com/ipgapi/schemas/a1">
         <v1:Transaction>
            <v1:CreditCardTxType>
               <v1:StoreId>45102030</v1:StoreId>
               <v1:Type>sale</v1:Type>
            </v1:CreditCardTxType>
            <v1:CreditCardData>
               <v1:CardNumber>476134******1117</v1:CardNumber>
               <v1:ExpMonth>12</v1:ExpMonth>
               <v1:ExpYear>26</v1:ExpYear>
               <v1:CardCodeValue>***</v1:CardCodeValue>
            </v1:CreditCardData>
            <v1:SelectedInstallmentPlan>
               <v1:InstallmentPlanId>d885a1aa-a9eb-fa86-412e-1c52bf97ab01</v1:InstallmentPlanId>
               <v1:InstallmentPlanIdReference>00000000TU</v1:InstallmentPlanIdReference>
               <v1:Provider>VIS</v1:Provider>
               <v1:Tenure>36</v1:Tenure>
               <v1:InterestRate>0</v1:InterestRate>
               <v1:Currency>SGD</v1:Currency>
               <v1:InstallmentFee>0.00</v1:InstallmentFee>
               <v1:TotalFee>0.00</v1:TotalFee>
               <v1:AmountPerMonth>126.56</v1:AmountPerMonth>
               <v1:TotalAmount>4556.00</v1:TotalAmount>
               <v1:TermsAndConditionText>test</v1:TermsAndConditionText>
               <v1:AdditionalTermsAndConditionsURL/>
               <v1:TermsAndConditionVersion>1</v1:TermsAndConditionVersion>
               <v1:InstallmentMerchantId>290070259330638</v1:InstallmentMerchantId>
               <v1:InstallmentTerminalId>19024144</v1:InstallmentTerminalId>
               <v1:LanguageCode>eng</v1:LanguageCode>
               <v1:Bank>
                  <v1:BankName>Visa Instalment program</v1:BankName>
                  <v1:BankCode>004</v1:BankCode>
               </v1:Bank>
            </v1:SelectedInstallmentPlan>
            <v1:Payment>
               <v1:ChargeTotal>4556</v1:ChargeTotal>
               <v1:Currency>SGD</v1:Currency>
            </v1:Payment>
            <v1:Billing>
               <v1:CustomerID>UKC0023557</v1:CustomerID>
               <v1:Name>Test Test</v1:Name>
               <v1:Address1>H Q Info</v1:Address1>
               <v1:Address2>Unit 6</v1:Address2>
               <v1:City>NEWMARKET</v1:City>
               <v1:State>GB</v1:State>
               <v1:Country>GB</v1:Country>
               <v1:Zip>CB8 7SH</v1:Zip>
               <v1:Phone>123-456-7890</v1:Phone>
               <v1:Email/>
            </v1:Billing>
         </v1:Transaction>
      </ns4:IPGApiOrderRequest>
   </soapenv:Body>
</soapenv:Envelope>

Optional: You can perform a void (cancellation) or return (linked refund). There is no need to include the installment plan details into the void or return request. See link for more details.

API Products

Point of Sale

Developer

Resources