com.cardpay.sdk.model

Class InstallmentData

java.lang.Object

com.cardpay.sdk.model.InstallmentData

public class InstallmentData
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstallmentData.PeriodEnum Initial period of recurring, can be `day`, `week`, `month`, `year`
static class	InstallmentData.TransTypeEnum Gets or Sets transType

Constructor Summary

Constructors

Constructor and Description
InstallmentData()

Method Summary

Modifier and Type	Method and Description
InstallmentData	amount(BigDecimal amount)
InstallmentData	currency(String currency)
InstallmentData	dynamicDescriptor(String dynamicDescriptor)
InstallmentData	generateToken(Boolean generateToken)
InstallmentData	initiator(String initiator)
InstallmentData	installmentAmount(BigDecimal installmentAmount)
InstallmentData	installmentType(String installmentType)
InstallmentData	interval(Integer interval) minimum: 1
InstallmentData	note(String note)
InstallmentData	payments(Integer payments)
InstallmentData	period(InstallmentData.PeriodEnum period)
InstallmentData	preauth(Boolean preauth)
InstallmentData	retries(Integer retries)
void	setAmount(BigDecimal amount)
void	setCurrency(String currency)
void	setDynamicDescriptor(String dynamicDescriptor)
void	setGenerateToken(Boolean generateToken)
void	setInitiator(String initiator)
void	setInstallmentAmount(BigDecimal installmentAmount)
void	setInstallmentType(String installmentType)
void	setInterval(Integer interval)
void	setNote(String note)
void	setPayments(Integer payments)
void	setPeriod(InstallmentData.PeriodEnum period)
void	setPreauth(Boolean preauth)
void	setRetries(Integer retries)
void	setSubscriptionStart(OffsetDateTime subscriptionStart)
void	setTransType(InstallmentData.TransTypeEnum transType)
InstallmentData	subscriptionStart(OffsetDateTime subscriptionStart)
String	toString()
InstallmentData	transType(InstallmentData.TransTypeEnum transType)

Methods inherited from class java.lang.Object

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

Constructor Detail

InstallmentData

public InstallmentData()

Method Detail

setAmount

public void setAmount(BigDecimal amount)

amount

public InstallmentData amount(BigDecimal amount)

Parameters:

amount - The total transaction amount in selected currency with dot as a decimal separator, must be less than 100 millions

Returns:

bean instance

setCurrency

public void setCurrency(String currency)

currency

public InstallmentData currency(String currency)

Parameters:

currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code

Returns:

bean instance

setDynamicDescriptor

public void setDynamicDescriptor(String dynamicDescriptor)

dynamicDescriptor

public InstallmentData dynamicDescriptor(String dynamicDescriptor)

Parameters:

dynamicDescriptor - Short description of the service or product, must be enabled by CardPay manager to be used.

Returns:

bean instance

setGenerateToken

public void setGenerateToken(Boolean generateToken)

generateToken

public InstallmentData generateToken(Boolean generateToken)

Parameters:

generateToken - This attribute can be received only in first recurring request. In all requests with recurring_id card.token can't be generated. If set to 'true', Card token will be generated and returned in GET response. Will be generated only for successful transactions (not for declined).

Returns:

bean instance

setInitiator

public void setInitiator(String initiator)

initiator

public InstallmentData initiator(String initiator)

Parameters:

initiator - Use `cit` for initiator attribute (cardholder initiated transaction).

Returns:

bean instance

setInstallmentAmount

public void setInstallmentAmount(BigDecimal installmentAmount)

installmentAmount

public InstallmentData installmentAmount(BigDecimal installmentAmount)

Parameters:

installmentAmount - Amount of 1 installment payment, should be less or equal to total amount of subscription, can have dot as a decimal separator. Mandatory for Payment Page Mode only.

Returns:

bean instance

setInstallmentType

public void setInstallmentType(String installmentType)

installmentType

public InstallmentData installmentType(String installmentType)

Parameters:

installmentType - Installment type, 4 possible values: `IF` - issuer financed `MF_HOLD' - merchant financed hold `MF_HOLD_SPLIT' - merchant financed split `MF_WITHOUT_HOLD' - merchant financed without hold

Returns:

bean instance

setInterval

public void setInterval(Integer interval)

interval

public InstallmentData interval(Integer interval)

minimum: 1

Parameters:

interval - Frequency interval of period, can be 1-365 depending on selected period value. Minimum value of period + interval can be 7 days / 1 week. Maximum value of period + interval plan can be 365 days / 52 weeks / 12 months / 1 year. 1-60 minutes - for **sandbox environment** and testing purpose only.

Returns:

bean instance

setNote

public void setNote(String note)

note

public InstallmentData note(String note)

Parameters:

note - Note about the recurring that will not be displayed to customer.

Returns:

bean instance

setPayments

public void setPayments(Integer payments)

payments

public InstallmentData payments(Integer payments)

Parameters:

payments - Number of total payments to be charged per defined interval, can be 2-200. For Mexican installment subscription (installment_type = `IF`) should be 1-99.

Returns:

bean instance

setPeriod

public void setPeriod(InstallmentData.PeriodEnum period)

period

public InstallmentData period(InstallmentData.PeriodEnum period)

Parameters:

period - Initial period of recurring, can be `day`, `week`, `month`, `year`

Returns:

bean instance

setPreauth

public void setPreauth(Boolean preauth)

preauth

public InstallmentData preauth(Boolean preauth)

Parameters:

preauth - If set to `true`, the amount will not be captured but only blocked. Installment with `preauth` attribute will be voided automatically in 5 days from the time of creating the preauth transaction.

Returns:

bean instance

setRetries

public void setRetries(Integer retries)

retries

public InstallmentData retries(Integer retries)

Parameters:

retries - Number of daily basis retry attempts in case of payment has not been captured successfully, from 1 to 15 attempts can be specified.

Returns:

bean instance

setSubscriptionStart

public void setSubscriptionStart(OffsetDateTime subscriptionStart)

subscriptionStart

public InstallmentData subscriptionStart(OffsetDateTime subscriptionStart)

Parameters:

subscriptionStart - The date in yyyy-MM-dd format when subscription will actually become activated (grace period). Auth request will be created but Customer will be charged only when subscription start date comes. Leave it empty or specify the current date to activate subscription at once without any grace period applied.

Returns:

bean instance

setTransType

public void setTransType(InstallmentData.TransTypeEnum transType)

transType

public InstallmentData transType(InstallmentData.TransTypeEnum transType)

Parameters:

transType - transType

Returns:

bean instance

toString

public String toString()

Overrides:

toString in class Object