AuthDataRequest (java-sdk 3.64.18 API)

java.lang.Object
- com.cardpay.sdk.model.AuthDataRequest

public class AuthDataRequest
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AuthDataRequest.TypeEnum
Gets or Sets type

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuthDataRequest.TypeEnum` Gets or Sets type

Constructor Summary

Constructors
Constructor and Description

AuthDataRequest()

Constructors
Constructor and Description
`AuthDataRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthDataRequest`	`addInstallmentsItem(Integer installmentsItem)`
`AuthDataRequest`	`amount(BigDecimal amount)`
`AuthDataRequest`	`currency(String currency)`
`AuthDataRequest`	`dynamicDescriptor(String dynamicDescriptor)`
`AuthDataRequest`	`generateToken(Boolean generateToken)`
`AuthDataRequest`	`installmentAmount(BigDecimal installmentAmount)`
`AuthDataRequest`	`installments(List<Integer> installments)`
`AuthDataRequest`	`installmentType(String installmentType)`
`AuthDataRequest`	`note(String note)`
`AuthDataRequest`	`recurringData(RecurringData recurringData)`
`AuthDataRequest`	`scaExemption(String scaExemption)`
`void`	`setAmount(BigDecimal amount)`
`void`	`setCurrency(String currency)`
`void`	`setDynamicDescriptor(String dynamicDescriptor)`
`void`	`setGenerateToken(Boolean generateToken)`
`void`	`setInstallmentAmount(BigDecimal installmentAmount)`
`void`	`setInstallments(List<Integer> installments)`
`void`	`setInstallmentType(String installmentType)`
`void`	`setNote(String note)`
`void`	`setRecurringData(RecurringData recurringData)`
`void`	`setScaExemption(String scaExemption)`
`void`	`setTransType(String transType)`
`void`	`setType(AuthDataRequest.TypeEnum type)`
`String`	`toString()`
`AuthDataRequest`	`transType(String transType)`
`AuthDataRequest`	`type(AuthDataRequest.TypeEnum type)`

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

- Constructor Detail
  - AuthDataRequest
```
public AuthDataRequest()
```
- Method Detail
  - setAmount
```
public void setAmount(BigDecimal amount)
```
  - amount
```
public AuthDataRequest amount(BigDecimal amount)
```
    Parameters:
    
    amount - The total invoice amount in selected currency with dot as a decimal separator, must be less than 10 billion
    
    Returns:
    
    bean instance
  - setCurrency
```
public void setCurrency(String currency)
```
  - currency
```
public AuthDataRequest 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 AuthDataRequest dynamicDescriptor(String dynamicDescriptor)
```
    Parameters:
    
    dynamicDescriptor - dynamicDescriptor
    
    Returns:
    
    bean instance
  - setGenerateToken
```
public void setGenerateToken(Boolean generateToken)
```
  - generateToken
```
public AuthDataRequest generateToken(Boolean generateToken)
```
    Parameters:
    
    generateToken - If set to `true`, token will be generated and returned in the response (callback). Token can be generated only for successful transactions (not for declined transactions) *(for BANKCARD payment method only)*
    
    Returns:
    
    bean instance
  - setInstallmentAmount
```
public void setInstallmentAmount(BigDecimal installmentAmount)
```
  - installmentAmount
```
public AuthDataRequest installmentAmount(BigDecimal installmentAmount)
```
    Parameters:
    
    installmentAmount - Amount of 1 installment authentication, should be less or equal to total amount of subscription, can have dot as a decimal separator. Mandatory for Payment Page Mode only.
    
    Returns:
    
    bean instance
  - setInstallmentType
```
public void setInstallmentType(String installmentType)
```
  - installmentType
```
public AuthDataRequest installmentType(String installmentType)
```
    Parameters:
    
    installmentType - Installment type, 2 possible values: `IF` - issuer financed `MF_HOLD' - merchant financed. For installment subscription with hold rest amount.
    
    Returns:
    
    bean instance
  - setInstallments
```
public void setInstallments(List<Integer> installments)
```
  - installments
```
public AuthDataRequest installments(List<Integer> installments)
```
    Parameters:
    
    installments - Number of total installment payments, to be charged per defined interval. For installment subscription with installment_type = `MF_HOLD` can be 1-12. For installment subscription with installment_type = `IF` can be 1-99.
    
    Returns:
    
    bean instance
  - addInstallmentsItem
```
public AuthDataRequest addInstallmentsItem(Integer installmentsItem)
```
  - setNote
```
public void setNote(String note)
```
  - note
```
public AuthDataRequest note(String note)
```
    Parameters:
    
    note - Note about the authentication, not shown to Customer
    
    Returns:
    
    bean instance
  - setRecurringData
```
public void setRecurringData(RecurringData recurringData)
```
  - recurringData
```
public AuthDataRequest recurringData(RecurringData recurringData)
```
    Parameters:
    
    recurringData - Recurring data
    
    Returns:
    
    bean instance
  - setScaExemption
```
public void setScaExemption(String scaExemption)
```
  - scaExemption
```
public AuthDataRequest scaExemption(String scaExemption)
```
    Parameters:
    
    scaExemption - Indicates the exemption type that you want to request for the authentication. Possible value: LOW_VALUE
    
    Returns:
    
    bean instance
  - setTransType
```
public void setTransType(String transType)
```
  - transType
```
public AuthDataRequest transType(String transType)
```
    Parameters:
    
    transType - Identifies the type of transaction being authenticated.
    
    Returns:
    
    bean instance
  - setType
```
public void setType(AuthDataRequest.TypeEnum type)
```
  - type
```
public AuthDataRequest type(AuthDataRequest.TypeEnum type)
```
    Parameters:
    
    type - type
    
    Returns:
    
    bean instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class AuthDataRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthDataRequest

Method Detail

setAmount

amount

setCurrency

currency

setDynamicDescriptor

dynamicDescriptor

setGenerateToken

generateToken

setInstallmentAmount

installmentAmount

setInstallmentType

installmentType

setInstallments

installments

addInstallmentsItem

setNote

note

setRecurringData

recurringData

setScaExemption

scaExemption

setTransType

transType

setType

type

toString