Instalment (Adyen Java API Library 17.3.0 API)

java.lang.Object
- com.adyen.model.nexo.Instalment

public class Instalment
extends Object

Definition: Information related an instalment transaction. -- Usage: To request an instalment to the issuer, or to make individual instalments of a payment transaction.

Java class for Instalment complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Instalment">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Instalment" type="{}InstalmentTypeList" minOccurs="0"/>
       </sequence>
       <attribute name="SequenceNumber" type="{}SequenceNumber" />
       <attribute name="PlanID" type="{}PlanID" />
       <attribute name="Period" type="{}Period" />
       <attribute name="PeriodUnit" type="{}PeriodUnitType" />
       <attribute name="FirstPaymentDate" type="{}ISODate" />
       <attribute name="TotalNbOfPayments" type="{}TotalNbOfPayments" />
       <attribute name="CumulativeAmount" type="{}SimpleAmountType" />
       <attribute name="FirstAmount" type="{}SimpleAmountType" />
       <attribute name="Charges" type="{}SimpleAmountType" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected BigDecimal`	`charges` The Charges.
`protected BigDecimal`	`cumulativeAmount` The Cumulative amount.
`protected BigDecimal`	`firstAmount` The First amount.
`protected String`	`firstPaymentDate` The First payment date.
`protected List<InstalmentType>`	`instalmentType` The Instalment type.
`protected BigInteger`	`period` The Period.
`protected PeriodUnitType`	`periodUnit` The Period unit.
`protected String`	`planID` The Plan id.
`protected BigInteger`	`sequenceNumber` The Sequence number.
`protected BigInteger`	`totalNbOfPayments` The Total nb of payments.

Constructor Summary

Constructors
Constructor and Description

Instalment()

Constructors
Constructor and Description
`Instalment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BigDecimal`	`getCharges()` Gets the value of the charges property.
`BigDecimal`	`getCumulativeAmount()` Gets the value of the cumulativeAmount property.
`BigDecimal`	`getFirstAmount()` Gets the value of the firstAmount property.
`String`	`getFirstPaymentDate()` Gets the value of the firstPaymentDate property.
`List<InstalmentType>`	`getInstalmentType()` Gets the value of the instalment property.
`BigInteger`	`getPeriod()` Gets the value of the period property.
`PeriodUnitType`	`getPeriodUnit()` Gets the value of the periodUnit property.
`String`	`getPlanID()` Gets the value of the planID property.
`BigInteger`	`getSequenceNumber()` Gets the value of the sequenceNumber property.
`BigInteger`	`getTotalNbOfPayments()` Gets the value of the totalNbOfPayments property.
`void`	`setCharges(BigDecimal value)` Sets the value of the charges property.
`void`	`setCumulativeAmount(BigDecimal value)` Sets the value of the cumulativeAmount property.
`void`	`setFirstAmount(BigDecimal value)` Sets the value of the firstAmount property.
`void`	`setFirstPaymentDate(String value)` Sets the value of the firstPaymentDate property.
`void`	`setPeriod(BigInteger value)` Sets the value of the period property.
`void`	`setPeriodUnit(PeriodUnitType value)` Sets the value of the periodUnit property.
`void`	`setPlanID(String value)` Sets the value of the planID property.
`void`	`setSequenceNumber(BigInteger value)` Sets the value of the sequenceNumber property.
`void`	`setTotalNbOfPayments(BigInteger value)` Sets the value of the totalNbOfPayments property.

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

- Field Detail
  - instalmentType
```
protected List<InstalmentType> instalmentType
```
    The Instalment type.
  - sequenceNumber
```
protected BigInteger sequenceNumber
```
    The Sequence number.
  - planID
```
protected String planID
```
    The Plan id.
  - period
```
protected BigInteger period
```
    The Period.
  - periodUnit
```
protected PeriodUnitType periodUnit
```
    The Period unit.
  - firstPaymentDate
```
protected String firstPaymentDate
```
    The First payment date.
  - totalNbOfPayments
```
protected BigInteger totalNbOfPayments
```
    The Total nb of payments.
  - cumulativeAmount
```
protected BigDecimal cumulativeAmount
```
    The Cumulative amount.
  - firstAmount
```
protected BigDecimal firstAmount
```
    The First amount.
  - charges
```
protected BigDecimal charges
```
    The Charges.
- Constructor Detail
  - Instalment
```
public Instalment()
```
- Method Detail
  - getInstalmentType
```
public List<InstalmentType> getInstalmentType()
```
    Gets the value of the instalment property.
    
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the instalment property.
    
    For example, to add a new item, do as follows:
```
    getInstalment().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InstalmentType
    Returns:
    
    the instalment
  - getSequenceNumber
```
public BigInteger getSequenceNumber()
```
    Gets the value of the sequenceNumber property.
    
    Returns:
    
    possible object is BigInteger
  - setSequenceNumber
```
public void setSequenceNumber(BigInteger value)
```
    Sets the value of the sequenceNumber property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getPlanID
```
public String getPlanID()
```
    Gets the value of the planID property.
    
    Returns:
    
    possible object is String
  - setPlanID
```
public void setPlanID(String value)
```
    Sets the value of the planID property.
    
    Parameters:
    
    value - allowed object is String
  - getPeriod
```
public BigInteger getPeriod()
```
    Gets the value of the period property.
    
    Returns:
    
    possible object is BigInteger
  - setPeriod
```
public void setPeriod(BigInteger value)
```
    Sets the value of the period property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getPeriodUnit
```
public PeriodUnitType getPeriodUnit()
```
    Gets the value of the periodUnit property.
    
    Returns:
    
    possible object is PeriodUnitType
  - setPeriodUnit
```
public void setPeriodUnit(PeriodUnitType value)
```
    Sets the value of the periodUnit property.
    
    Parameters:
    
    value - allowed object is PeriodUnitType
  - getFirstPaymentDate
```
public String getFirstPaymentDate()
```
    Gets the value of the firstPaymentDate property.
    
    Returns:
    
    possible object is String
  - setFirstPaymentDate
```
public void setFirstPaymentDate(String value)
```
    Sets the value of the firstPaymentDate property.
    
    Parameters:
    
    value - allowed object is String
  - getTotalNbOfPayments
```
public BigInteger getTotalNbOfPayments()
```
    Gets the value of the totalNbOfPayments property.
    
    Returns:
    
    possible object is BigInteger
  - setTotalNbOfPayments
```
public void setTotalNbOfPayments(BigInteger value)
```
    Sets the value of the totalNbOfPayments property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getCumulativeAmount
```
public BigDecimal getCumulativeAmount()
```
    Gets the value of the cumulativeAmount property.
    
    Returns:
    
    possible object is BigDecimal
  - setCumulativeAmount
```
public void setCumulativeAmount(BigDecimal value)
```
    Sets the value of the cumulativeAmount property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getFirstAmount
```
public BigDecimal getFirstAmount()
```
    Gets the value of the firstAmount property.
    
    Returns:
    
    possible object is BigDecimal
  - setFirstAmount
```
public void setFirstAmount(BigDecimal value)
```
    Sets the value of the firstAmount property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getCharges
```
public BigDecimal getCharges()
```
    Gets the value of the charges property.
    
    Returns:
    
    possible object is BigDecimal
  - setCharges
```
public void setCharges(BigDecimal value)
```
    Sets the value of the charges property.
    
    Parameters:
    
    value - allowed object is BigDecimal

Class Instalment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

instalmentType

sequenceNumber

planID

period

periodUnit

firstPaymentDate

totalNbOfPayments

cumulativeAmount

firstAmount

charges

Constructor Detail

Instalment

Method Detail

getInstalmentType

getSequenceNumber

setSequenceNumber

getPlanID

setPlanID

getPeriod

setPeriod

getPeriodUnit

setPeriodUnit

getFirstPaymentDate

setFirstPaymentDate

getTotalNbOfPayments

setTotalNbOfPayments

getCumulativeAmount

setCumulativeAmount

getFirstAmount

setFirstAmount

getCharges

setCharges