Ptsv2paymentsInstallmentInformation (cybersource-rest-client-java 0.0.85 API)

java.lang.Object
- Model.Ptsv2paymentsInstallmentInformation

public class Ptsv2paymentsInstallmentInformation
extends Object

Ptsv2paymentsInstallmentInformation

Constructor Summary

Constructors
Constructor and Description

Ptsv2paymentsInstallmentInformation()

Constructors
Constructor and Description
`Ptsv2paymentsInstallmentInformation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ptsv2paymentsInstallmentInformation`	`amount(String amount)`
`Ptsv2paymentsInstallmentInformation`	`annualInterestRate(String annualInterestRate)`
`Ptsv2paymentsInstallmentInformation`	`eligibilityInquiry(String eligibilityInquiry)`
`boolean`	`equals(Object o)`
`Ptsv2paymentsInstallmentInformation`	`firstInstallmentAmount(String firstInstallmentAmount)`
`Ptsv2paymentsInstallmentInformation`	`firstInstallmentDate(String firstInstallmentDate)`
`Ptsv2paymentsInstallmentInformation`	`frequency(String frequency)`
`String`	`getAmount()` Amount for the current installment payment.
`String`	`getAnnualInterestRate()` Annual interest rate.
`String`	`getEligibilityInquiry()` Indicates whether the authorization request is a Crediario eligibility inquiry.
`String`	`getFirstInstallmentAmount()` Amount of the first installment payment.
`String`	`getFirstInstallmentDate()` Date of the first installment payment.
`String`	`getFrequency()` Frequency of the installment payments.
`String`	`getGracePeriodDuration()` Grace period requested by the customer before the first installment payment is due.
`String`	`getGracePeriodDurationType()` Unit for the requested grace period duration.
`String`	`getIdentifier()` Standing Instruction/Installment identifier.
`String`	`getInterestIndicator()` Indicates if the installment plan has interest.
`String`	`getInvoiceData()` Invoice information that you want to provide to the issuer.
`String`	`getPaymentType()` Payment plan for the installments.
`String`	`getPlanType()` #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment.
`Integer`	`getSequence()` Installment number when making payments in installments.
`String`	`getTotalAmount()` Total amount of the loan that is being paid in installments.
`Integer`	`getTotalCount()` Total number of installments when making payments in installments.
`String`	`getValidationIndicator()` Standing Instruction/Installment validation indicator.
`Ptsv2paymentsInstallmentInformation`	`gracePeriodDuration(String gracePeriodDuration)`
`Ptsv2paymentsInstallmentInformation`	`gracePeriodDurationType(String gracePeriodDurationType)`
`int`	`hashCode()`
`Ptsv2paymentsInstallmentInformation`	`identifier(String identifier)`
`Ptsv2paymentsInstallmentInformation`	`interestIndicator(String interestIndicator)`
`Ptsv2paymentsInstallmentInformation`	`invoiceData(String invoiceData)`
`Boolean`	`IsGovernmentPlan()` Indicates if an installment plan is a government sponsored or part of a government program.
`Ptsv2paymentsInstallmentInformation`	`isGovernmentPlan(Boolean isGovernmentPlan)`
`Ptsv2paymentsInstallmentInformation`	`paymentType(String paymentType)`
`Ptsv2paymentsInstallmentInformation`	`planType(String planType)`
`Ptsv2paymentsInstallmentInformation`	`sequence(Integer sequence)`
`void`	`setAmount(String amount)`
`void`	`setAnnualInterestRate(String annualInterestRate)`
`void`	`setEligibilityInquiry(String eligibilityInquiry)`
`void`	`setFirstInstallmentAmount(String firstInstallmentAmount)`
`void`	`setFirstInstallmentDate(String firstInstallmentDate)`
`void`	`setFrequency(String frequency)`
`void`	`setGracePeriodDuration(String gracePeriodDuration)`
`void`	`setGracePeriodDurationType(String gracePeriodDurationType)`
`void`	`setIdentifier(String identifier)`
`void`	`setInterestIndicator(String interestIndicator)`
`void`	`setInvoiceData(String invoiceData)`
`void`	`setIsGovernmentPlan(Boolean isGovernmentPlan)`
`void`	`setPaymentType(String paymentType)`
`void`	`setPlanType(String planType)`
`void`	`setSequence(Integer sequence)`
`void`	`setTotalAmount(String totalAmount)`
`void`	`setTotalCount(Integer totalCount)`
`void`	`setValidationIndicator(String validationIndicator)`
`String`	`toString()`
`Ptsv2paymentsInstallmentInformation`	`totalAmount(String totalAmount)`
`Ptsv2paymentsInstallmentInformation`	`totalCount(Integer totalCount)`
`Ptsv2paymentsInstallmentInformation`	`validationIndicator(String validationIndicator)`

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

- Constructor Detail
  - Ptsv2paymentsInstallmentInformation
```
public Ptsv2paymentsInstallmentInformation()
```
- Method Detail
  - amount
```
public Ptsv2paymentsInstallmentInformation amount(String amount)
```
  - getAmount
```
public String getAmount()
```
    Amount for the current installment payment. This field is supported only for CyberSource through VisaNet.
    
    Returns:
    
    amount
  - setAmount
```
public void setAmount(String amount)
```
  - frequency
```
public Ptsv2paymentsInstallmentInformation frequency(String frequency)
```
  - getFrequency
```
public String getFrequency()
```
    Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency
    
    Returns:
    
    frequency
  - setFrequency
```
public void setFrequency(String frequency)
```
  - planType
```
public Ptsv2paymentsInstallmentInformation planType(String planType)
```
  - getPlanType
```
public String getPlanType()
```
    #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant)
    
    Returns:
    
    planType
  - setPlanType
```
public void setPlanType(String planType)
```
  - sequence
```
public Ptsv2paymentsInstallmentInformation sequence(Integer sequence)
```
  - getSequence
```
public Integer getSequence()
```
    Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. maximum: 999
    
    Returns:
    
    sequence
  - setSequence
```
public void setSequence(Integer sequence)
```
  - totalAmount
```
public Ptsv2paymentsInstallmentInformation totalAmount(String totalAmount)
```
  - getTotalAmount
```
public String getTotalAmount()
```
    Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet.
    
    Returns:
    
    totalAmount
  - setTotalAmount
```
public void setTotalAmount(String totalAmount)
```
  - totalCount
```
public Ptsv2paymentsInstallmentInformation totalCount(Integer totalCount)
```
  - getTotalCount
```
public Integer getTotalCount()
```
    Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. maximum: 999
    
    Returns:
    
    totalCount
  - setTotalCount
```
public void setTotalCount(Integer totalCount)
```
  - firstInstallmentDate
```
public Ptsv2paymentsInstallmentInformation firstInstallmentDate(String firstInstallmentDate)
```
  - getFirstInstallmentDate
```
public String getFirstInstallmentDate()
```
    Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment
    
    Returns:
    
    firstInstallmentDate
  - setFirstInstallmentDate
```
public void setFirstInstallmentDate(String firstInstallmentDate)
```
  - invoiceData
```
public Ptsv2paymentsInstallmentInformation invoiceData(String invoiceData)
```
  - getInvoiceData
```
public String getInvoiceData()
```
    Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification
    
    Returns:
    
    invoiceData
  - setInvoiceData
```
public void setInvoiceData(String invoiceData)
```
  - paymentType
```
public Ptsv2paymentsInstallmentInformation paymentType(String paymentType)
```
  - getPaymentType
```
public String getPaymentType()
```
    Payment plan for the installments. This field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow. Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card: - 1: SI with a fixed amount. - 2: SI with a maximum amount. - 3: Other kind of SI. Possible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia - 1: Registration or first transaction. - 2: Subsequent transaction. Possible values for other kinds of installment payments: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. - 6: SI de-registration on RuPay for the payer authentication seamless flow.
    
    Returns:
    
    paymentType
  - setPaymentType
```
public void setPaymentType(String paymentType)
```
  - eligibilityInquiry
```
public Ptsv2paymentsInstallmentInformation eligibilityInquiry(String eligibilityInquiry)
```
  - getEligibilityInquiry
```
public String getEligibilityInquiry()
```
    Indicates whether the authorization request is a Crediario eligibility inquiry. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.
    
    Returns:
    
    eligibilityInquiry
  - setEligibilityInquiry
```
public void setEligibilityInquiry(String eligibilityInquiry)
```
  - gracePeriodDuration
```
public Ptsv2paymentsInstallmentInformation gracePeriodDuration(String gracePeriodDuration)
```
  - getGracePeriodDuration
```
public String getGracePeriodDuration()
```
    Grace period requested by the customer before the first installment payment is due. When you include this field in a request, you must also include the grace period duration type field. The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 100-101, Field: Mastercard Grace Period Details. This field is supported only for Mastercard installment payments in Brazil and Greece.
    
    Returns:
    
    gracePeriodDuration
  - setGracePeriodDuration
```
public void setGracePeriodDuration(String gracePeriodDuration)
```
  - gracePeriodDurationType
```
public Ptsv2paymentsInstallmentInformation gracePeriodDurationType(String gracePeriodDurationType)
```
  - getGracePeriodDurationType
```
public String getGracePeriodDurationType()
```
    Unit for the requested grace period duration. Possible values: - `D`: Days - `W`: Weeks - `M`: Months The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 99, Field: Mastercard Grace Period Details This field is supported only for Mastercard installment payments in Brazil and Greece on CyberSource through VisaNet.
    
    Returns:
    
    gracePeriodDurationType
  - setGracePeriodDurationType
```
public void setGracePeriodDurationType(String gracePeriodDurationType)
```
  - firstInstallmentAmount
```
public Ptsv2paymentsInstallmentInformation firstInstallmentAmount(String firstInstallmentAmount)
```
  - getFirstInstallmentAmount
```
public String getFirstInstallmentAmount()
```
    Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment
    
    Returns:
    
    firstInstallmentAmount
  - setFirstInstallmentAmount
```
public void setFirstInstallmentAmount(String firstInstallmentAmount)
```
  - validationIndicator
```
public Ptsv2paymentsInstallmentInformation validationIndicator(String validationIndicator)
```
  - getValidationIndicator
```
public String getValidationIndicator()
```
    Standing Instruction/Installment validation indicator. - '1': Prevalidated - '2': Not Validated
    
    Returns:
    
    validationIndicator
  - setValidationIndicator
```
public void setValidationIndicator(String validationIndicator)
```
  - identifier
```
public Ptsv2paymentsInstallmentInformation identifier(String identifier)
```
  - getIdentifier
```
public String getIdentifier()
```
    Standing Instruction/Installment identifier.
    
    Returns:
    
    identifier
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - annualInterestRate
```
public Ptsv2paymentsInstallmentInformation annualInterestRate(String annualInterestRate)
```
  - getAnnualInterestRate
```
public String getAnnualInterestRate()
```
    Annual interest rate. This field is returned only for two kinds of installment payments on Visa Platform Connect: - Crediario with Visa in Brazil: this field is included in the authorization response for the Crediario eligibility request when the issuer approves the customer's request for Crediario installment payments. - Mastercard in all countries except Brazil, Croatia, Georgia, and Greece. Example: A value of 1.0 specifies 1%. Example: A value of 4.0 specifies 4%. #### Brazil The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate #### Other Countries The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 58-62 SCMP API Fields| 216 - Field: Mastercard Annual Percentage Rate
    
    Returns:
    
    annualInterestRate
  - setAnnualInterestRate
```
public void setAnnualInterestRate(String annualInterestRate)
```
  - interestIndicator
```
public Ptsv2paymentsInstallmentInformation interestIndicator(String interestIndicator)
```
  - getInterestIndicator
```
public String getInterestIndicator()
```
    Indicates if the installment plan has interest. Possible values: -Y - with interest -N - without interest -NULL - Do not send the field if no information available
    
    Returns:
    
    interestIndicator
  - setInterestIndicator
```
public void setInterestIndicator(String interestIndicator)
```
  - isGovernmentPlan
```
public Ptsv2paymentsInstallmentInformation isGovernmentPlan(Boolean isGovernmentPlan)
```
  - IsGovernmentPlan
```
public Boolean IsGovernmentPlan()
```
    Indicates if an installment plan is a government sponsored or part of a government program. Possible values: -true -false This field defaults to false when no value is provided.
    
    Returns:
    
    isGovernmentPlan
  - setIsGovernmentPlan
```
public void setIsGovernmentPlan(Boolean isGovernmentPlan)
```
  - 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 Ptsv2paymentsInstallmentInformation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ptsv2paymentsInstallmentInformation

Method Detail

amount

getAmount

setAmount

frequency

getFrequency

setFrequency

planType

getPlanType

setPlanType

sequence

getSequence

setSequence

totalAmount

getTotalAmount

setTotalAmount

totalCount

getTotalCount

setTotalCount

firstInstallmentDate

getFirstInstallmentDate

setFirstInstallmentDate

invoiceData

getInvoiceData

setInvoiceData

paymentType

getPaymentType

setPaymentType

eligibilityInquiry

getEligibilityInquiry

setEligibilityInquiry

gracePeriodDuration

getGracePeriodDuration

setGracePeriodDuration

gracePeriodDurationType

getGracePeriodDurationType

setGracePeriodDurationType

firstInstallmentAmount

getFirstInstallmentAmount

setFirstInstallmentAmount

validationIndicator

getValidationIndicator

setValidationIndicator

identifier

getIdentifier

setIdentifier

annualInterestRate

getAnnualInterestRate

setAnnualInterestRate

interestIndicator

getInterestIndicator

setInterestIndicator

isGovernmentPlan

IsGovernmentPlan

setIsGovernmentPlan

equals

hashCode

toString