PlatformPayoutConfigWebhookData class abstract

PlatformPayoutConfigWebhookData

Properties:

  • balancePlatform - The unique identifier of the balance platform.
  • balancePlatformPayoutScheduleId - The unique identifier of the balance platform payout schedule that is applied to the balance account.
  • countryCode - The two-letter ISO 3166-1 alpha-2 code of the country to which the payout schedule applies.
  • currency - The three-character ISO code of the currency used for the payout schedule.
  • defaultDescription - The default description for payouts initiated by this payout schedule.
  • defaultFrequency - The default frequency of payouts initiated by this payout schedule.
  • defaultFrequencyValue - The default value for date of the month or day of the week when payouts are initiated. Allowed only if defaultFrequency is monthly or weekly. Possible values if frequency is monthly: 1 - 31. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (29, 30, or 31) does not exist in a month, the payout is initiated on the last day of that month. Possible values if defaultFrequency is weekly: 1 - 5.
  • defaultReference - Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.
  • defaultReferenceForBeneficiary - The default reference for beneficiary for payouts initiated by this payout schedule.
  • maxPayoutAmount - The maximum amount that can be paid out from balance accounts that use this payout schedule.
  • minPayoutAmount - The minimum amount that can be paid out from balance accounts that use this payout schedule.
  • retainedAmount - The amount of funds that must remain available in a balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.
Annotations
  • @BuiltValue.new()

Properties

balancePlatform → String?
The unique identifier of the balance platform.
no setter
balancePlatformPayoutScheduleId → String?
The unique identifier of the balance platform payout schedule that is applied to the balance account.
no setter
countryCode → String?
The two-letter ISO 3166-1 alpha-2 code of the country to which the payout schedule applies.
no setter
currency → String?
The three-character ISO code of the currency used for the payout schedule.
no setter
defaultDescription → String?
The default description for payouts initiated by this payout schedule.
no setter
defaultFrequency → String?
The default frequency of payouts initiated by this payout schedule.
no setter
defaultFrequencyValue → int?
The default value for date of the month or day of the week when payouts are initiated. Allowed only if defaultFrequency is monthly or weekly. Possible values if frequency is monthly: 1 - 31. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (29, 30, or 31) does not exist in a month, the payout is initiated on the last day of that month. Possible values if defaultFrequency is weekly: 1 - 5.
no setter
defaultReference → String?
Your internal default reference for the payout schedule. When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.
no setter
defaultReferenceForBeneficiary → String?
The default reference for beneficiary for payouts initiated by this payout schedule.
no setter
hashCode → int
The hash code for this object.
no setterinherited
maxPayoutAmount → int?
The maximum amount that can be paid out from balance accounts that use this payout schedule.
no setter
minPayoutAmount → int?
The minimum amount that can be paid out from balance accounts that use this payout schedule.
no setter
retainedAmount → int?
The amount of funds that must remain available in a balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

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