BalanceAccountConfiguration class abstract

BalanceAccountConfiguration

Properties:

  • balanceAccountId - The unique identifier of the balance account to which you apply the payout schedule.
  • balancePlatformPayoutScheduleId - The unique identifier of the balance platform payout schedule that is applied to the balance account.
  • createdAt - The date and time when the payout schedule was created.
  • 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. Default value: The defaultDescription from the balance platform schedule that you are applying.
  • enabled - Specifies whether the payout schedule is active.
  • frequency - The frequency of payouts initiated by this payout schedule. Possible values: * daily * weekdays * weekly * monthly Default value: The defaultFrequency from the balance platform schedule that you are applying.
  • 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. Default value: The defaultFrequencyValue from the balance platform schedule that you are applying.
  • id - The unique identifier of the payout schedule for the balance account.
  • maxPayoutAmount - The maximum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0
  • minPayoutAmount - The minimum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0
  • reference - Your reference for the payout schedule. This reference does not appear on statements of payouts initiated by 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 payout and is included in all webhooks related to the payout. Supported characters: a-z, A-Z, 0-9. Default value: The defaultReferenceForBeneficiary from the balance platform schedule that you are applying.
  • 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. Default value: 0
  • 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.
  • updatedAt - The date and time when the payout schedule was updated.
Annotations
  • @BuiltValue.new()

Constructors

BalanceAccountConfiguration([void updates(BalanceAccountConfigurationBuilder b)])
factory

Properties

balanceAccountId → String
The unique identifier of the balance account to which you apply the payout schedule.
no setter
balancePlatformPayoutScheduleId → String
The unique identifier of the balance platform payout schedule that is applied to the balance account.
no setter
createdAt → DateTime
The date and time when the payout schedule was created.
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. Default value: The defaultDescription from the balance platform schedule that you are applying.
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 Default value: The defaultFrequency from the balance platform schedule that you are applying.
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. Default value: The defaultFrequencyValue from the balance platform schedule that you are applying.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The unique identifier of the payout schedule for the balance account.
no setter
maxPayoutAmount → int?
The maximum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0
no setter
minPayoutAmount → int?
The minimum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0
no setter
reference → String?
Your reference for the payout schedule. This reference does not appear on statements of payouts initiated by 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 payout and is included in all webhooks related to the payout. Supported characters: a-z, A-Z, 0-9. Default value: The defaultReferenceForBeneficiary from the balance platform schedule that you are applying.
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. Default value: 0
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
updatedAt → DateTime?
The date and time when the payout schedule was updated.
no setter

Methods

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