public class RecurringRequestRecurringData extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
RecurringRequestRecurringData.PeriodEnum
Initial period of recurring, can be `day`, `week`, `month`, `year`.
|
| Constructor and Description |
|---|
RecurringRequestRecurringData() |
public void setAmount(BigDecimal amount)
public RecurringRequestRecurringData amount(BigDecimal amount)
amount - The total transaction amount in selected currency with dot as a decimal separator, must be less than 100 millionspublic void setCurrency(String currency)
public RecurringRequestRecurringData currency(String currency)
currency - [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency codepublic void setDynamicDescriptor(String dynamicDescriptor)
public RecurringRequestRecurringData dynamicDescriptor(String dynamicDescriptor)
dynamicDescriptor - Short description of the service or product, must be enabled by CardPay manager to be used.public void setFiling(RecurringRequestFiling filing)
public RecurringRequestRecurringData filing(RecurringRequestFiling filing)
filing - Filing data, should be send in all recurring requests besides first recurring request First recurring request should be send without filing attributepublic void setGenerateToken(Boolean generateToken)
public RecurringRequestRecurringData generateToken(Boolean generateToken)
generateToken - This attribute can be received only in first recurring request. In all requests with recurring_id card.token can't be generated. If set to 'true', card token will be generated and returned in GET response. Will be generated only for successful transactions (not for declined).public void setInitiator(String initiator)
public RecurringRequestRecurringData initiator(String initiator)
initiator - Can be only 2 values: `mit` (merchant initiated transaction), `cit` (cardholder initiated transaction)public void setInterval(Integer interval)
public RecurringRequestRecurringData interval(Integer interval)
interval - Frequency interval of period, can be 1-365 depending on selected period value. Minimum value of period + interval can be 7 days / 1 week. Maximum value of period + interval plan can be 365 days / 52 weeks / 12 months / 1 year. 1-60 minutes - for **sandbox environment** and testing purpose only.public void setNote(String note)
public RecurringRequestRecurringData note(String note)
note - Note about the recurring that will not be displayed to customer.public void setPayments(Integer payments)
public RecurringRequestRecurringData payments(Integer payments)
payments - Number of total payments to be charged per defined interval, can be 2-200.public void setPeriod(RecurringRequestRecurringData.PeriodEnum period)
public RecurringRequestRecurringData period(RecurringRequestRecurringData.PeriodEnum period)
period - Initial period of recurring, can be `day`, `week`, `month`, `year`. `minute` - for **sandbox environment** and testing purpose only.public void setPlan(Plan plan)
public RecurringRequestRecurringData plan(Plan plan)
plan - Plan datapublic void setPreauth(Boolean preauth)
public RecurringRequestRecurringData preauth(Boolean preauth)
preauth - This parameter is allowed to be used only for first recurring payment. If set to `true`, the amount will not be captured but only blocked *(for BANKCARD payment method only)*.public void setRetries(Integer retries)
public RecurringRequestRecurringData retries(Integer retries)
retries - Number of daily basis retry attempts in case of payment has not been captured successfully, from 1 to 15 attempts can be specified.public void setSubscriptionStart(OffsetDateTime subscriptionStart)
public RecurringRequestRecurringData subscriptionStart(OffsetDateTime subscriptionStart)
subscriptionStart - The date in yyyy-MM-dd format when subscription will actually become activated (grace period). Auth request will be created but Customer will be charged only when subscription start date comes. Leave it empty or specify the current date to activate subscription at once without any grace period applied.Copyright © 2019. All rights reserved.