RecurringFilterParameters (java-sdk 1.4.4.8 API)

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

public class RecurringFilterParameters
extends Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RecurringFilterParameters.SortOrderEnum` Sort based on order of results.
`static class`	`RecurringFilterParameters.TypeEnum` Filter recurring payments by certain type (applicable to /api/recurrings endpoint only): `SCHEDULED` for scheduled recurring payments `ONECLICK` for one-click payments `INSTALLMENT` for installment payments

Constructor Summary

Constructors
Constructor and Description

RecurringFilterParameters()

Constructors
Constructor and Description
`RecurringFilterParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RecurringFilterParameters`	`currency(String currency)`
`RecurringFilterParameters`	`endTime(OffsetDateTime endTime)`
`RecurringFilterParameters`	`maxCount(Integer maxCount)` maximum: 10000
`RecurringFilterParameters`	`merchantOrderId(String merchantOrderId)`
`RecurringFilterParameters`	`paymentMethod(String paymentMethod)`
`RecurringFilterParameters`	`requestId(String requestId)`
`void`	`setCurrency(String currency)`
`void`	`setEndTime(OffsetDateTime endTime)`
`void`	`setMaxCount(Integer maxCount)`
`void`	`setMerchantOrderId(String merchantOrderId)`
`void`	`setPaymentMethod(String paymentMethod)`
`void`	`setRequestId(String requestId)`
`void`	`setSortOrder(RecurringFilterParameters.SortOrderEnum sortOrder)`
`void`	`setStartTime(OffsetDateTime startTime)`
`void`	`setType(RecurringFilterParameters.TypeEnum type)`
`RecurringFilterParameters`	`sortOrder(RecurringFilterParameters.SortOrderEnum sortOrder)`
`RecurringFilterParameters`	`startTime(OffsetDateTime startTime)`
`String`	`toString()`
`RecurringFilterParameters`	`type(RecurringFilterParameters.TypeEnum type)`

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

- Constructor Detail
  - RecurringFilterParameters
```
public RecurringFilterParameters()
```
- Method Detail
  - setRequestId
```
public void setRequestId(String requestId)
```
  - requestId
```
public RecurringFilterParameters requestId(String requestId)
```
    Parameters:
    
    requestId - Request ID
    
    Returns:
    
    bean instance
  - setMerchantOrderId
```
public void setMerchantOrderId(String merchantOrderId)
```
  - merchantOrderId
```
public RecurringFilterParameters merchantOrderId(String merchantOrderId)
```
    Parameters:
    
    merchantOrderId - Merchant order number from the merchant system
    
    Returns:
    
    bean instance
  - setPaymentMethod
```
public void setPaymentMethod(String paymentMethod)
```
  - paymentMethod
```
public RecurringFilterParameters paymentMethod(String paymentMethod)
```
    Parameters:
    
    paymentMethod - Used payment method type name from payment methods list
    
    Returns:
    
    bean instance
  - setStartTime
```
public void setStartTime(OffsetDateTime startTime)
```
  - startTime
```
public RecurringFilterParameters startTime(OffsetDateTime startTime)
```
    Parameters:
    
    startTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period starts (inclusive), UTC time, default is 24 hours before 'end_time' (format: yyyy-MM-dd'T'HH:mm:ss'Z')
    
    Returns:
    
    bean instance
  - setEndTime
```
public void setEndTime(OffsetDateTime endTime)
```
  - endTime
```
public RecurringFilterParameters endTime(OffsetDateTime endTime)
```
    Parameters:
    
    endTime - Date and time up to milliseconds (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format) when requested period ends (not inclusive), UTC time, must be less than 7 days after 'start_time', default is current time (format: yyyy-MM-dd'T'HH:mm:ss'Z')
    
    Returns:
    
    bean instance
  - setMaxCount
```
public void setMaxCount(Integer maxCount)
```
  - maxCount
```
public RecurringFilterParameters maxCount(Integer maxCount)
```
    maximum: 10000
    
    Parameters:
    
    maxCount - Limit number of returned transactions (must be less than 10000, default is 1000)
    
    Returns:
    
    bean instance
  - setSortOrder
```
public void setSortOrder(RecurringFilterParameters.SortOrderEnum sortOrder)
```
  - sortOrder
```
public RecurringFilterParameters sortOrder(RecurringFilterParameters.SortOrderEnum sortOrder)
```
    Parameters:
    
    sortOrder - Sort based on order of results. `asc` for ascending order or `desc` for descending order (default value)
    
    Returns:
    
    bean instance
  - setCurrency
```
public void setCurrency(String currency)
```
  - currency
```
public RecurringFilterParameters currency(String currency)
```
    Parameters:
    
    currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of transactions currency
    
    Returns:
    
    bean instance
  - setType
```
public void setType(RecurringFilterParameters.TypeEnum type)
```
  - type
```
public RecurringFilterParameters type(RecurringFilterParameters.TypeEnum type)
```
    Parameters:
    
    type - Filter recurring payments by certain type (applicable to /api/recurrings endpoint only): `SCHEDULED` for scheduled recurring payments `ONECLICK` for one-click payments `INSTALLMENT` for installment payments
    
    Returns:
    
    bean instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RecurringFilterParameters

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecurringFilterParameters

Method Detail

setRequestId

requestId

setMerchantOrderId

merchantOrderId

setPaymentMethod

paymentMethod

setStartTime

startTime

setEndTime

endTime

setMaxCount

maxCount

setSortOrder

sortOrder

setCurrency

currency

setType

type

toString