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`

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	interval(Integer interval) minimum: 1
InstallmentData	note(String note)
InstallmentData	payments(Integer payments) minimum: 2 maximum: 200
InstallmentData	period(InstallmentData.PeriodEnum period)
InstallmentData	retries(Integer retries) minimum: 1 maximum: 15
void	setAmount(BigDecimal amount)
void	setCurrency(String currency)
void	setDynamicDescriptor(String dynamicDescriptor)
void	setGenerateToken(Boolean generateToken)
void	setInitiator(String initiator)
void	setInterval(Integer interval)
void	setNote(String note)
void	setPayments(Integer payments)
void	setPeriod(InstallmentData.PeriodEnum period)
void	setRetries(Integer retries)
void	setSubscriptionStart(OffsetDateTime subscriptionStart)
InstallmentData	subscriptionStart(OffsetDateTime subscriptionStart)
String	toString()

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 - dynamicDescriptor

Returns:

bean instance

setGenerateToken

public void setGenerateToken(Boolean generateToken)

generateToken

public InstallmentData generateToken(Boolean generateToken)

Parameters:

generateToken - generateToken

Returns:

bean instance

setInitiator

public void setInitiator(String initiator)

initiator

public InstallmentData initiator(String initiator)

Parameters:

initiator - initiator

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

Returns:

bean instance

setPayments

public void setPayments(Integer payments)

payments

public InstallmentData payments(Integer payments)

minimum: 2 maximum: 200

Parameters:

payments - Number of total payments to be charged per defined interval, can be 2-200.

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

setRetries

public void setRetries(Integer retries)

retries

public InstallmentData retries(Integer retries)

minimum: 1 maximum: 15

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

toString

public String toString()

Overrides:

toString in class Object