AccountPayoutConfigWebhookData class abstract

AccountPayoutConfigWebhookData

Properties:

  • balanceAccountId - The unique identifier of the balance account to which the payout schedule was applied.
  • balanceAccountPayoutScheduleId - The unique identifier of the balance platform payout schedule that was applied to the balance account.
  • balancePlatform - The unique identifier of the balance platform.
  • currency - The three-character ISO code of the currency used for this schedule.
  • description - The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.
  • enabled - Specifies whether the payout schedule is active.
  • frequency - The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly
  • frequencyValue - The date of the month or day of the week when payouts are initiated. Allowed only if frequency 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 frequency is weekly: 1 - 5.
  • 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.
  • reference - Your internal reference of the payout schedule.
  • referenceForBeneficiary - The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: a-z, A-Z, 0-9, - and space. Spaces might be replaced with - if the recipient bank or payment infrastructure does not allow spaces.
  • retainedAmount - The amount of funds that must remain available in the 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.
  • salesDayClosingTime - The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: HH:mm:SS
  • transferInstrumentId - The unique identifier of the transfer instrument to which the funds are paid out.
Annotations
  • @BuiltValue.new()

Properties

balanceAccountId → String?
The unique identifier of the balance account to which the payout schedule was applied.
no setter
balanceAccountPayoutScheduleId → String?
The unique identifier of the balance platform payout schedule that was applied to the balance account.
no setter
balancePlatform → String?
The unique identifier of the balance platform.
no setter
currency → String?
The three-character ISO code of the currency used for this schedule.
no setter
description → String?
The description used for all payouts initiated by this payout schedule. Maximum length: 140 characters. If your description is longer, it may be truncated.
no setter
enabled → bool?
Specifies whether the payout schedule is active.
no setter
frequency → String?
The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly
no setter
frequencyValue → int?
The date of the month or day of the week when payouts are initiated. Allowed only if frequency 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 frequency is weekly: 1 - 5.
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
reference → String?
Your internal reference of the payout schedule.
no setter
referenceForBeneficiary → String?
The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout. Supported characters: a-z, A-Z, 0-9, - and space. Spaces might be replaced with - if the recipient bank or payment infrastructure does not allow spaces.
no setter
retainedAmount → int?
The amount of funds that must remain available in the 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
salesDayClosingTime → String?
The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00. Format: HH:mm:SS
no setter
transferInstrumentId → String?
The unique identifier of the transfer instrument to which the funds are paid out.
no setter

Methods

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