Ptsv2paymentsRecurringPaymentInformation (cybersource-rest-client-java 0.0.76 API)

java.lang.Object
- Model.Ptsv2paymentsRecurringPaymentInformation

public class Ptsv2paymentsRecurringPaymentInformation
extends Object

This object contains recurring payment information.

Constructor Summary

Constructors
Constructor and Description

Ptsv2paymentsRecurringPaymentInformation()

Constructors
Constructor and Description
`Ptsv2paymentsRecurringPaymentInformation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ptsv2paymentsRecurringPaymentInformation`	`amountType(String amountType)`
`Ptsv2paymentsRecurringPaymentInformation`	`endDate(String endDate)`
`boolean`	`equals(Object o)`
`Ptsv2paymentsRecurringPaymentInformation`	`frequency(Integer frequency)`
`String`	`getAmountType()` Indicates recurring amount type agreed by the cardholder Valid Values : 1- Fixed amount recurring payment 2- Recurring payment with maximum amount
`String`	`getEndDate()` The date after which no further recurring authorizations should be performed.
`Integer`	`getFrequency()` Integer value indicating the minimum number of days between recurring authorizations.
`String`	`getMaximumAmount()` This API field will contain the maximum amount agreed to by the cardholder.
`Integer`	`getNumberOfPayments()` Total number of payments for the duration of the recurring subscription.
`String`	`getOccurrence()` This value indicates how often a recurring payment occurs.
`String`	`getOriginalPurchaseDate()` Date of original purchase.
`String`	`getReferenceNumber()` This will contain a unique reference number for the recurring payment transaction.
`Integer`	`getSequenceNumber()` This field is mandatory for Cartes Bancaires recurring transactions on Credit Mutuel-CIC.
`String`	`getType()` This contains the type of recurring payment.
`String`	`getValidationIndicator()` This tag will contain a value that indicates whether or not the recurring payment transaction has been validated.
`int`	`hashCode()`
`Ptsv2paymentsRecurringPaymentInformation`	`maximumAmount(String maximumAmount)`
`Ptsv2paymentsRecurringPaymentInformation`	`numberOfPayments(Integer numberOfPayments)`
`Ptsv2paymentsRecurringPaymentInformation`	`occurrence(String occurrence)`
`Ptsv2paymentsRecurringPaymentInformation`	`originalPurchaseDate(String originalPurchaseDate)`
`Ptsv2paymentsRecurringPaymentInformation`	`referenceNumber(String referenceNumber)`
`Ptsv2paymentsRecurringPaymentInformation`	`sequenceNumber(Integer sequenceNumber)`
`void`	`setAmountType(String amountType)`
`void`	`setEndDate(String endDate)`
`void`	`setFrequency(Integer frequency)`
`void`	`setMaximumAmount(String maximumAmount)`
`void`	`setNumberOfPayments(Integer numberOfPayments)`
`void`	`setOccurrence(String occurrence)`
`void`	`setOriginalPurchaseDate(String originalPurchaseDate)`
`void`	`setReferenceNumber(String referenceNumber)`
`void`	`setSequenceNumber(Integer sequenceNumber)`
`void`	`setType(String type)`
`void`	`setValidationIndicator(String validationIndicator)`
`String`	`toString()`
`Ptsv2paymentsRecurringPaymentInformation`	`type(String type)`
`Ptsv2paymentsRecurringPaymentInformation`	`validationIndicator(String validationIndicator)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Ptsv2paymentsRecurringPaymentInformation
```
public Ptsv2paymentsRecurringPaymentInformation()
```
- Method Detail
  - endDate
```
public Ptsv2paymentsRecurringPaymentInformation endDate(String endDate)
```
  - getEndDate
```
public String getEndDate()
```
    The date after which no further recurring authorizations should be performed. Format: `YYYY-MM-DD` **Note** This field is required for recurring transactions.
    
    Returns:
    
    endDate
  - setEndDate
```
public void setEndDate(String endDate)
```
  - frequency
```
public Ptsv2paymentsRecurringPaymentInformation frequency(Integer frequency)
```
  - getFrequency
```
public Integer getFrequency()
```
    Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months. Example: 6 months = 168 Example values accepted (31 days): - 31 - 031 - 0031 **Note** This field is required for recurring transactions.
    
    Returns:
    
    frequency
  - setFrequency
```
public void setFrequency(Integer frequency)
```
  - numberOfPayments
```
public Ptsv2paymentsRecurringPaymentInformation numberOfPayments(Integer numberOfPayments)
```
  - getNumberOfPayments
```
public Integer getNumberOfPayments()
```
    Total number of payments for the duration of the recurring subscription.
    
    Returns:
    
    numberOfPayments
  - setNumberOfPayments
```
public void setNumberOfPayments(Integer numberOfPayments)
```
  - originalPurchaseDate
```
public Ptsv2paymentsRecurringPaymentInformation originalPurchaseDate(String originalPurchaseDate)
```
  - getOriginalPurchaseDate
```
public String getOriginalPurchaseDate()
```
    Date of original purchase. Required for recurring transactions. Format: `YYYY-MM-DDTHH:MM:SSZ` **Note**: If this field is empty, the current date is used.
    
    Returns:
    
    originalPurchaseDate
  - setOriginalPurchaseDate
```
public void setOriginalPurchaseDate(String originalPurchaseDate)
```
  - sequenceNumber
```
public Ptsv2paymentsRecurringPaymentInformation sequenceNumber(Integer sequenceNumber)
```
  - getSequenceNumber
```
public Integer getSequenceNumber()
```
    This field is mandatory for Cartes Bancaires recurring transactions on Credit Mutuel-CIC. This field records recurring sequence, e.g. 1st for initial, 2 for subsequent, 3 etc
    
    Returns:
    
    sequenceNumber
  - setSequenceNumber
```
public void setSequenceNumber(Integer sequenceNumber)
```
  - type
```
public Ptsv2paymentsRecurringPaymentInformation type(String type)
```
  - getType
```
public String getType()
```
    This contains the type of recurring payment. Valid Values : 1 - Registration/First transaction 2 - Subsequent transaction 3 - Modification 4 - Cancellation
    
    Returns:
    
    type
  - setType
```
public void setType(String type)
```
  - occurrence
```
public Ptsv2paymentsRecurringPaymentInformation occurrence(String occurrence)
```
  - getOccurrence
```
public String getOccurrence()
```
    This value indicates how often a recurring payment occurs. Valid Values : • 01 (Daily) • 02 (Twice weekly) • 03 (Weekly) • 04 (Ten days) • 05 (Fortnightly) • 06 (Monthly) • 07 (Every two months) • 08 (Trimester) • 09 (Quarterly) • 10 (Twice yearly) • 11 (Annually) • 12 (Unscheduled)
    
    Returns:
    
    occurrence
  - setOccurrence
```
public void setOccurrence(String occurrence)
```
  - validationIndicator
```
public Ptsv2paymentsRecurringPaymentInformation validationIndicator(String validationIndicator)
```
  - getValidationIndicator
```
public String getValidationIndicator()
```
    This tag will contain a value that indicates whether or not the recurring payment transaction has been validated. Valid values : 0- Not validated 1- Validated
    
    Returns:
    
    validationIndicator
  - setValidationIndicator
```
public void setValidationIndicator(String validationIndicator)
```
  - amountType
```
public Ptsv2paymentsRecurringPaymentInformation amountType(String amountType)
```
  - getAmountType
```
public String getAmountType()
```
    Indicates recurring amount type agreed by the cardholder Valid Values : 1- Fixed amount recurring payment 2- Recurring payment with maximum amount
    
    Returns:
    
    amountType
  - setAmountType
```
public void setAmountType(String amountType)
```
  - maximumAmount
```
public Ptsv2paymentsRecurringPaymentInformation maximumAmount(String maximumAmount)
```
  - getMaximumAmount
```
public String getMaximumAmount()
```
    This API field will contain the maximum amount agreed to by the cardholder. The currency of this amount will be specified in Field 49—Currency Code,Transaction.
    
    Returns:
    
    maximumAmount
  - setMaximumAmount
```
public void setMaximumAmount(String maximumAmount)
```
  - referenceNumber
```
public Ptsv2paymentsRecurringPaymentInformation referenceNumber(String referenceNumber)
```
  - getReferenceNumber
```
public String getReferenceNumber()
```
    This will contain a unique reference number for the recurring payment transaction.
    
    Returns:
    
    referenceNumber
  - setReferenceNumber
```
public void setReferenceNumber(String referenceNumber)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Ptsv2paymentsRecurringPaymentInformation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ptsv2paymentsRecurringPaymentInformation

Method Detail

endDate

getEndDate

setEndDate

frequency

getFrequency

setFrequency

numberOfPayments

getNumberOfPayments

setNumberOfPayments

originalPurchaseDate

getOriginalPurchaseDate

setOriginalPurchaseDate

sequenceNumber

getSequenceNumber

setSequenceNumber

type

getType

setType

occurrence

getOccurrence

setOccurrence

validationIndicator

getValidationIndicator

setValidationIndicator

amountType

getAmountType

setAmountType

maximumAmount

getMaximumAmount

setMaximumAmount

referenceNumber

getReferenceNumber

setReferenceNumber

equals

hashCode

toString