RecurringTopUp class abstract
RecurringTopUp
Properties:
- counterparty - The details about the counterparty that is funding the top-up.
- description - Your description for the recurring top-up. Maximum length is 140 characters. If you set a longer description, it will be cut off at 140 characters.
- id - The unique identifier of the top up.
- referenceForBeneficiary - A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: a-z, A-Z, 0-9.
- status - The status of the recurring top-up. If not provided, by default, this is set to active. Possible values: * active: the top up is enabled and funds will be pulled in. * inactive: the top up is disabled and cannot be triggered.
- topUpAmount - The currency and value to be added to the balance account, specified in minor units. This can be a fixed amount or a target amount.
- trigger - The condition that triggers the top-up. This can be a recurring schedule or a minimum balance threshold.
- Annotations
-
- @BuiltValue.new()
Constructors
- RecurringTopUp([void updates(RecurringTopUpBuilder b)])
-
factory
Properties
- counterparty → TopUpCounterparty
-
The details about the counterparty that is funding the top-up.
no setter
- description → String
-
Your description for the recurring top-up. Maximum length is 140 characters. If you set a longer description, it will be cut off at 140 characters.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String
-
The unique identifier of the top up.
no setter
- referenceForBeneficiary → String?
-
A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both parties involved in the funds movement. Supported characters: a-z, A-Z, 0-9.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → RecurringTopUpStatusEnum?
-
The status of the recurring top-up. If not provided, by default, this is set to active. Possible values: * active: the top up is enabled and funds will be pulled in. * inactive: the top up is disabled and cannot be triggered.
no setter
- topUpAmount → TopUpAmount
-
The currency and value to be added to the balance account, specified in minor units. This can be a fixed amount or a target amount.
no setter
- trigger → Trigger
-
The condition that triggers the top-up. This can be a recurring schedule or a minimum balance threshold.
no setter
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
dynamic updates(RecurringTopUpBuilder)) → RecurringTopUp -
Rebuilds the instance.
inherited
-
toBuilder(
) → RecurringTopUpBuilder -
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<
RecurringTopUp> -
no setter