WebhookTopUpConfiguration class abstract

WebhookTopUpConfiguration

Properties:

  • counterparty - The source of the funds.
  • description - The message that is used in the top-up transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message is cut off at 140 characters.
  • id - The unique identifier of the recurring top-up configuration.
  • mandate - The mandate associated with the recurring 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 top-up configuration. Possible values: * active: the top-up is enabled and funds are pulled in. * inactive: the top-up is disabled and cannot be triggered.
  • topUpAmount - The amount of the top-up. 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

WebhookTopUpConfiguration([void updates(WebhookTopUpConfigurationBuilder b)])
factory

Properties

counterparty → WebhookTopUpCounterparty
The source of the funds.
no setter
description → String
The message that is used in the top-up transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message is cut off at 140 characters.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
The unique identifier of the recurring top-up configuration.
no setter
mandate → WebhookTopUpMandate?
The mandate associated with the recurring 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 → WebhookTopUpConfigurationStatusEnum
The status of the top-up configuration. Possible values: * active: the top-up is enabled and funds are pulled in. * inactive: the top-up is disabled and cannot be triggered.
no setter
topUpAmount → WebhookTopUpAmount
The amount of the top-up. This can be a fixed amount or a target amount.
no setter
trigger → WebhookTopUpTrigger
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(WebhookTopUpConfigurationBuilder)) → WebhookTopUpConfiguration
Rebuilds the instance.
inherited
toBuilder() → WebhookTopUpConfigurationBuilder
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<WebhookTopUpConfiguration>
no setter