Mandate class abstract

Mandate

Properties:

  • amount - The billing amount (in minor units) of the recurring transactions.
  • amountRule - The limitation rule of the billing amount. Possible values: * max: The transaction amount can not exceed the amount. * exact: The transaction amount should be the same as the amount.
  • billingAttemptsRule - The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * on: On a specific date. * before: Before and on a specific date. * after: On and after a specific date.
  • billingDay - The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the frequency.
  • count - The number of transactions that can be performed within the given frequency.
  • endsAt - End date of the billing plan, in YYYY-MM-DD format.
  • frequency - The frequency with which a shopper should be charged. Possible values: adhoc, daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly.
  • remarks - The message shown by UPI to the shopper on the approval screen.
  • startsAt - Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
Annotations
  • @BuiltValue.new()

Constructors

Mandate([void updates(MandateBuilder b)])
factory

Properties

amount → String
The billing amount (in minor units) of the recurring transactions.
no setter
amountRule → MandateAmountRuleEnum?
The limitation rule of the billing amount. Possible values: * max: The transaction amount can not exceed the amount. * exact: The transaction amount should be the same as the amount.
no setter
billingAttemptsRule → MandateBillingAttemptsRuleEnum?
The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * on: On a specific date. * before: Before and on a specific date. * after: On and after a specific date.
no setter
billingDay → String?
The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the frequency.
no setter
count → String?
The number of transactions that can be performed within the given frequency.
no setter
endsAt → String
End date of the billing plan, in YYYY-MM-DD format.
no setter
frequency → MandateFrequencyEnum
The frequency with which a shopper should be charged. Possible values: adhoc, daily, weekly, biWeekly, monthly, quarterly, halfYearly, yearly.
no setter
hashCode → int
The hash code for this object.
no setterinherited
remarks → String?
The message shown by UPI to the shopper on the approval screen.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
startsAt → String?
Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(MandateBuilder)) → Mandate
Rebuilds the instance.
inherited
toBuilder() → MandateBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<Mandate>
no setter