com.worldline.connect.sdk.java.v1.domain

Class Installments

java.lang.Object

com.worldline.connect.sdk.java.v1.domain.Installments

public class Installments
extends Object

Object containing data related to installments which can be used for card payments and only with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.

Constructor Summary

Constructors

Constructor and Description
Installments()

Method Summary

Modifier and Type	Method and Description
AmountOfMoney	getAmountOfMoneyPerInstallment() The amount that will be paid per installment.
AmountOfMoney	getAmountOfMoneyTotal() Object containing the total amount and ISO currency code attributes
String	getFrequencyOfInstallments() The frequency in which the installments will be collected from the customer.
Integer	getInstallmentPlanCode() The code for the installment plan.
String	getInterestRate() The interest rate paid for installments expressed in percentage.
Long	getNumberOfInstallments() The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products.
void	setAmountOfMoneyPerInstallment(AmountOfMoney value) The amount that will be paid per installment.
void	setAmountOfMoneyTotal(AmountOfMoney value) Object containing the total amount and ISO currency code attributes
void	setFrequencyOfInstallments(String value) The frequency in which the installments will be collected from the customer.
void	setInstallmentPlanCode(Integer value) The code for the installment plan.
void	setInterestRate(String value) The interest rate paid for installments expressed in percentage.
void	setNumberOfInstallments(Long value) The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Installments

public Installments()

Method Detail

getAmountOfMoneyPerInstallment

public AmountOfMoney getAmountOfMoneyPerInstallment()

The amount that will be paid per installment. The total amount of amountOfMoneyPerInstallment x numberOfInstallments can not be higher than the total amount of this transaction, although we will not validate that.
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.

setAmountOfMoneyPerInstallment

public void setAmountOfMoneyPerInstallment(AmountOfMoney value)

The amount that will be paid per installment. The total amount of amountOfMoneyPerInstallment x numberOfInstallments can not be higher than the total amount of this transaction, although we will not validate that.
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.

getAmountOfMoneyTotal

public AmountOfMoney getAmountOfMoneyTotal()

Object containing the total amount and ISO currency code attributes

setAmountOfMoneyTotal

public void setAmountOfMoneyTotal(AmountOfMoney value)

Object containing the total amount and ISO currency code attributes

getFrequencyOfInstallments

public String getFrequencyOfInstallments()

The frequency in which the installments will be collected from the customer. The possible values are:

• daily
• weekly
• monthly (default)
• quarterly

For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), only the value monthly is valid.

setFrequencyOfInstallments

public void setFrequencyOfInstallments(String value)

The frequency in which the installments will be collected from the customer. The possible values are:

• daily
• weekly
• monthly (default)
• quarterly

For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), only the value monthly is valid.

getInstallmentPlanCode

public Integer getInstallmentPlanCode()

The code for the installment plan. The possible values are:

• 43 No-interest, 3 month Installmentplan
• 46No-interest, 6 month Installmentplan
• 49No-interest, 9 month Installmentplan
• 52No-interest, 12 month Installmentplan

setInstallmentPlanCode

public void setInstallmentPlanCode(Integer value)

The code for the installment plan. The possible values are:

• 43 No-interest, 3 month Installmentplan
• 46No-interest, 6 month Installmentplan
• 49No-interest, 9 month Installmentplan
• 52No-interest, 12 month Installmentplan

getInterestRate

public String getInterestRate()

The interest rate paid for installments expressed in percentage. So for example 5.75 means 5.75%
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.

setInterestRate

public void setInterestRate(String value)

The interest rate paid for installments expressed in percentage. So for example 5.75 means 5.75%
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.

getNumberOfInstallments

public Long getNumberOfInstallments()

The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products. Only used with some acquirers. In case you send in the details of this object, only the payment products (or combination of card products and acquirers) that support installments will be shown on the MyCheckout hosted payment pages. If this property is not provided the customer will not see details on the installment plan in a HostedCheckout.
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), there is a maximum of 12 installments.

setNumberOfInstallments

public void setNumberOfInstallments(Long value)

The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products. Only used with some acquirers. In case you send in the details of this object, only the payment products (or combination of card products and acquirers) that support installments will be shown on the MyCheckout hosted payment pages. If this property is not provided the customer will not see details on the installment plan in a HostedCheckout.
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), there is a maximum of 12 installments.