TokenMandate class abstract

TokenMandate

Properties:

  • accountIdType - The type of account identifier for the masked account number.
  • 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.
  • currency - The three-character ISO currency code.
  • 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.
  • mandateId - The unique identifier of the mandate.
  • maskedAccountId - The masked account number associated with the mandate.
  • minAmount - For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app.
  • previousMandateId - The previous value of the mandateId, if the scheme has replaced it. For UPI mandates, the mandateId is the Unique Mandate Number (UMN), which the scheme replaces when the mandate moves to another payment provider. In that case, this field holds the UMN the mandate was registered with before the move.
  • providerId - The provider-specific identifier for this mandate.
  • purposeCode - The purpose code the mandate is registered with at the scheme. Possible values for UPI mandates: * 14: The mandate can only be debited by the payment provider that registered it. * AZ: The mandate can be debited by any payment provider.
  • recurringAmount - For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment.
  • recurringStatement - The text that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
  • remarks - Additional remarks or notes about the mandate.
  • retryPolicy - When set to true, you can retry for failed recurring payments. The default value is true.
  • startsAt - Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
  • status - The status of the mandate. Examples : active, revoked, completed, expired
  • txVariant - The transaction variant used for this mandate.
Annotations
  • @BuiltValue.new()

Constructors

TokenMandate([void updates(TokenMandateBuilder b)])
factory

Properties

accountIdType → String?
The type of account identifier for the masked account number.
no setter
amount → String
The billing amount (in minor units) of the recurring transactions.
no setter
amountRule → TokenMandateAmountRuleEnum?
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 → TokenMandateBillingAttemptsRuleEnum?
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
currency → String
The three-character ISO currency code.
no setter
endsAt → String
End date of the billing plan, in YYYY-MM-DD format.
no setter
frequency → TokenMandateFrequencyEnum
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
mandateId → String
The unique identifier of the mandate.
no setter
maskedAccountId → String?
The masked account number associated with the mandate.
no setter
minAmount → String?
For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app.
no setter
previousMandateId → String?
The previous value of the mandateId, if the scheme has replaced it. For UPI mandates, the mandateId is the Unique Mandate Number (UMN), which the scheme replaces when the mandate moves to another payment provider. In that case, this field holds the UMN the mandate was registered with before the move.
no setter
providerId → String
The provider-specific identifier for this mandate.
no setter
purposeCode → String?
The purpose code the mandate is registered with at the scheme. Possible values for UPI mandates: * 14: The mandate can only be debited by the payment provider that registered it. * AZ: The mandate can be debited by any payment provider.
no setter
recurringAmount → String?
For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment.
no setter
recurringStatement → String?
The text that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.
no setter
remarks → String?
Additional remarks or notes about the mandate.
no setter
retryPolicy → TokenMandateRetryPolicyEnum?
When set to true, you can retry for failed recurring payments. The default value is true.
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
status → String
The status of the mandate. Examples : active, revoked, completed, expired
no setter
txVariant → String
The transaction variant used for this mandate.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(TokenMandateBuilder)) → TokenMandate
Rebuilds the instance.
inherited
toBuilder() → TokenMandateBuilder
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<TokenMandate>
no setter