com.cardpay.sdk.model

Class RecurringResponseRecurringData

java.lang.Object

com.cardpay.sdk.model.RecurringResponseRecurringData

public class RecurringResponseRecurringData
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecurringResponseRecurringData.ScheduledTypeEnum Scheduled payment type attribute.
static class	RecurringResponseRecurringData.StatusEnum Current recurring payment status
static class	RecurringResponseRecurringData.TransTypeEnum Gets or Sets transType
static class	RecurringResponseRecurringData.TypeEnum Recurring payment type name; can be ONECLICK, SCHEDULED, INSTALLMENT

Constructor Summary

Constructors

Constructor and Description
RecurringResponseRecurringData()

Method Summary

Modifier and Type	Method and Description
RecurringResponseRecurringData	addInvalidDataItem(String invalidDataItem)
RecurringResponseRecurringData	amount(BigDecimal amount)
RecurringResponseRecurringData	arn(String arn)
RecurringResponseRecurringData	authCode(String authCode)
RecurringResponseRecurringData	begin(Boolean begin)
RecurringResponseRecurringData	created(String created)
RecurringResponseRecurringData	currency(String currency)
RecurringResponseRecurringData	declineCode(String declineCode)
RecurringResponseRecurringData	declineReason(String declineReason)
RecurringResponseRecurringData	extendedDeclineReason(String extendedDeclineReason)
RecurringResponseRecurringData	filing(RecurringResponseFiling filing)
RecurringResponseRecurringData	holdPeriod(Integer holdPeriod)
RecurringResponseRecurringData	id(String id)
RecurringResponseRecurringData	initiator(String initiator)
RecurringResponseRecurringData	installmentAmount(BigDecimal installmentAmount)
RecurringResponseRecurringData	installmentType(String installmentType)
RecurringResponseRecurringData	invalidData(List<String> invalidData)
RecurringResponseRecurringData	is3d(Boolean is3d)
RecurringResponseRecurringData	networkTransId(String networkTransId)
RecurringResponseRecurringData	note(String note)
RecurringResponseRecurringData	payments(String payments)
RecurringResponseRecurringData	postauthStatus(String postauthStatus)
RecurringResponseRecurringData	rrn(String rrn)
RecurringResponseRecurringData	scheduledType(RecurringResponseRecurringData.ScheduledTypeEnum scheduledType)
void	setAmount(BigDecimal amount)
void	setArn(String arn)
void	setAuthCode(String authCode)
void	setBegin(Boolean begin)
void	setCreated(String created)
void	setCurrency(String currency)
void	setDeclineCode(String declineCode)
void	setDeclineReason(String declineReason)
void	setExtendedDeclineReason(String extendedDeclineReason)
void	setFiling(RecurringResponseFiling filing)
void	setHoldPeriod(Integer holdPeriod)
void	setId(String id)
void	setInitiator(String initiator)
void	setInstallmentAmount(BigDecimal installmentAmount)
void	setInstallmentType(String installmentType)
void	setInvalidData(List<String> invalidData)
void	setIs3d(Boolean is3d)
void	setNetworkTransId(String networkTransId)
void	setNote(String note)
void	setPayments(String payments)
void	setPostauthStatus(String postauthStatus)
void	setRrn(String rrn)
void	setScheduledType(RecurringResponseRecurringData.ScheduledTypeEnum scheduledType)
void	setStatus(RecurringResponseRecurringData.StatusEnum status)
void	setSubscription(Subscription subscription)
void	setTransType(RecurringResponseRecurringData.TransTypeEnum transType)
void	setType(RecurringResponseRecurringData.TypeEnum type)
RecurringResponseRecurringData	status(RecurringResponseRecurringData.StatusEnum status)
RecurringResponseRecurringData	subscription(Subscription subscription)
String	toString()
RecurringResponseRecurringData	transType(RecurringResponseRecurringData.TransTypeEnum transType)
RecurringResponseRecurringData	type(RecurringResponseRecurringData.TypeEnum type)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecurringResponseRecurringData

public RecurringResponseRecurringData()

Method Detail

setAmount

public void setAmount(BigDecimal amount)

amount

public RecurringResponseRecurringData amount(BigDecimal amount)

Parameters:

amount - Recurring amount

Returns:

bean instance

setArn

public void setArn(String arn)

arn

public RecurringResponseRecurringData arn(String arn)

Parameters:

arn - ARN (Acquirer Reference Number), supplied by the acquiring financial institution, return only after receiving ARN from bank acquirer *(for BANKCARD payment method only)*

Returns:

bean instance

setAuthCode

public void setAuthCode(String authCode)

authCode

public RecurringResponseRecurringData authCode(String authCode)

Parameters:

authCode - Authorization code, provided by bank

Returns:

bean instance

setBegin

public void setBegin(Boolean begin)

begin

public RecurringResponseRecurringData begin(Boolean begin)

Parameters:

begin - Callback: show first/next recurring

Returns:

bean instance

setCreated

public void setCreated(String created)

created

public RecurringResponseRecurringData created(String created)

Parameters:

created - Date and time when this recurring payment was created, [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format

Returns:

bean instance

setCurrency

public void setCurrency(String currency)

currency

public RecurringResponseRecurringData currency(String currency)

Parameters:

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

Returns:

bean instance

setDeclineCode

public void setDeclineCode(String declineCode)

declineCode

public RecurringResponseRecurringData declineCode(String declineCode)

Parameters:

declineCode - Decline code (only in decline case)

Returns:

bean instance

setDeclineReason

public void setDeclineReason(String declineReason)

declineReason

public RecurringResponseRecurringData declineReason(String declineReason)

Parameters:

declineReason - Bank's message about transaction decline reason (only in decline case)

Returns:

bean instance

setExtendedDeclineReason

public void setExtendedDeclineReason(String extendedDeclineReason)

extendedDeclineReason

public RecurringResponseRecurringData extendedDeclineReason(String extendedDeclineReason)

Parameters:

extendedDeclineReason - Original decline reason. Can be presented in responses if original network response code is presented and option is enabled for Merchant. Not presented by default, ask Unlimit manager to enable it if needed.

Returns:

bean instance

setFiling

public void setFiling(RecurringResponseFiling filing)

filing

public RecurringResponseRecurringData filing(RecurringResponseFiling filing)

Parameters:

filing - CardPay's filing data

Returns:

bean instance

setHoldPeriod

public void setHoldPeriod(Integer holdPeriod)

holdPeriod

public RecurringResponseRecurringData holdPeriod(Integer holdPeriod)

Parameters:

holdPeriod - The delay between the authorisation and scheduled auto-capture or auto-void, specified in hours. The minimum hold period is 1 hour, maximum hold period is 7 days (168 hours).

Returns:

bean instance

setId

public void setId(String id)

id

public RecurringResponseRecurringData id(String id)

Parameters:

id - CardPay's recurring id

Returns:

bean instance

setInitiator

public void setInitiator(String initiator)

initiator

public RecurringResponseRecurringData initiator(String initiator)

Parameters:

initiator - Initiator of scheduled transaction (applicable only for scheduled by merchant payments)

Returns:

bean instance

setInstallmentAmount

public void setInstallmentAmount(BigDecimal installmentAmount)

installmentAmount

public RecurringResponseRecurringData installmentAmount(BigDecimal installmentAmount)

Parameters:

installmentAmount - Amount of 1 installment payment, will be returned if presented in request (for payment page mode only)

Returns:

bean instance

setInstallmentType

public void setInstallmentType(String installmentType)

installmentType

public RecurringResponseRecurringData installmentType(String installmentType)

Parameters:

installmentType - Selected installment type

Returns:

bean instance

setInvalidData

public void setInvalidData(List<String> invalidData)

invalidData

public RecurringResponseRecurringData invalidData(List<String> invalidData)

Parameters:

invalidData - Invalid card or billing data

Returns:

bean instance

addInvalidDataItem

public RecurringResponseRecurringData addInvalidDataItem(String invalidDataItem)

setIs3d

public void setIs3d(Boolean is3d)

is3d

public RecurringResponseRecurringData is3d(Boolean is3d)

Parameters:

is3d - Was 3-D Secure authentication made or not

Returns:

bean instance

setNetworkTransId

public void setNetworkTransId(String networkTransId)

networkTransId

public RecurringResponseRecurringData networkTransId(String networkTransId)

Parameters:

networkTransId - Network Reference Number of original transaction

Returns:

bean instance

setNote

public void setNote(String note)

note

public RecurringResponseRecurringData note(String note)

Parameters:

note - Payment note

Returns:

bean instance

setPayments

public void setPayments(String payments)

payments

public RecurringResponseRecurringData payments(String payments)

Parameters:

payments - Number of total payments, to be charged

Returns:

bean instance

setPostauthStatus

public void setPostauthStatus(String postauthStatus)

postauthStatus

public RecurringResponseRecurringData postauthStatus(String postauthStatus)

Parameters:

postauthStatus - The value contains payment status after hold period if payment has not been completed. Possible values: COMPLETE, REVERSE

Returns:

bean instance

setRrn

public void setRrn(String rrn)

rrn

public RecurringResponseRecurringData rrn(String rrn)

Parameters:

rrn - RRN (Retrieval Reference Number), supplied by the acquiring financial institution

Returns:

bean instance

setScheduledType

public void setScheduledType(RecurringResponseRecurringData.ScheduledTypeEnum scheduledType)

scheduledType

public RecurringResponseRecurringData scheduledType(RecurringResponseRecurringData.ScheduledTypeEnum scheduledType)

Parameters:

scheduledType - Scheduled payment type attribute. `SM` - value for scheduled by merchant case `SA` - value for scheduled by acquirer case

Returns:

bean instance

setStatus

public void setStatus(RecurringResponseRecurringData.StatusEnum status)

status

public RecurringResponseRecurringData status(RecurringResponseRecurringData.StatusEnum status)

Parameters:

status - Current recurring payment status

Returns:

bean instance

setSubscription

public void setSubscription(Subscription subscription)

subscription

public RecurringResponseRecurringData subscription(Subscription subscription)

Parameters:

subscription - Subscription data. Mandatory if scheduled payment is requested.

Returns:

bean instance

setType

public void setType(RecurringResponseRecurringData.TypeEnum type)

type

public RecurringResponseRecurringData type(RecurringResponseRecurringData.TypeEnum type)

Parameters:

type - Recurring payment type name; can be ONECLICK, SCHEDULED, INSTALLMENT

Returns:

bean instance

setTransType

public void setTransType(RecurringResponseRecurringData.TransTypeEnum transType)

transType

public RecurringResponseRecurringData transType(RecurringResponseRecurringData.TransTypeEnum transType)

Parameters:

transType - transType

Returns:

bean instance

toString

public String toString()

Overrides:

toString in class Object