BalancePlatformConfiguration class abstract

BalancePlatformConfiguration

Properties:

  • automaticApplication - Specifies whether this payout schedule is automatically applied to new balance accounts.
  • balancePlatformId - The balance platform to which the payout schedule applies.
  • countryCode - The two-letter ISO 3166-1 alpha-2 code of the country to which the payout schedule applies.
  • createdAt - The date when the payout schedule was created.
  • 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 defaultFrequency 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.
  • defaultReferenceForBeneficiary - The default reference for beneficiary for payouts initiated by this payout schedule.
  • enabled - Specifies whether the payout schedule is enabled immediately after it is created.
  • id - The unique identifier of the payout schedule for your balance platform.
  • maxPayoutAmount - The maximum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0, which means that there is no maximum limit.
  • minPayoutAmount - The minimum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0.
  • payoutScheduleDescription - The type of payout schedule. This type indicates how fast funds are paid out to your user. Possible values: - Standard: The funds arrive in your user's transfer instrument two days after the funds are settled. - Accelerated: The funds arrive to your user's transfer instrument the day after the funds are settled.
  • 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. Default value: 0
  • updatedAt - The date when the payout schedule was updated.
  • userSettlementDelay - The default settlement delay for this payout schedule.
  • userSettlementTime - The time when the payout funds are settled in your user's transfer instrument. For example, 11:30:00.
  • userSettlementTimeZone - The timezone of the userSettlementTime.
Annotations
  • @BuiltValue.new()

Constructors

BalancePlatformConfiguration([void updates(BalancePlatformConfigurationBuilder b)])
factory

Properties

automaticApplication → bool?
Specifies whether this payout schedule is automatically applied to new balance accounts.
no setter
balancePlatformId → String
The balance platform to which the payout schedule applies.
no setter
countryCode → String?
The two-letter ISO 3166-1 alpha-2 code of the country to which the payout schedule applies.
no setter
createdAt → DateTime
The date when the payout schedule was created.
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 defaultFrequency 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.
no setter
defaultReferenceForBeneficiary → String?
The default reference for beneficiary for payouts initiated by this payout schedule.
no setter
enabled → bool?
Specifies whether the payout schedule is enabled immediately after it is created.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String?
The unique identifier of the payout schedule for your balance platform.
no setter
maxPayoutAmount → int?
The maximum amount that can be paid out from balance accounts that use this payout schedule. Default value: 0, which means that there is no maximum limit.
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
payoutScheduleDescription → String
The type of payout schedule. This type indicates how fast funds are paid out to your user. Possible values: - Standard: The funds arrive in your user's transfer instrument two days after the funds are settled. - Accelerated: The funds arrive to your user's transfer instrument the day after the funds are settled.
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. Default value: 0
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
updatedAt → DateTime?
The date when the payout schedule was updated.
no setter
userSettlementDelay → int
The default settlement delay for this payout schedule.
no setter
userSettlementTime → String
The time when the payout funds are settled in your user's transfer instrument. For example, 11:30:00.
no setter
userSettlementTimeZone → String
The timezone of the userSettlementTime.
no setter

Methods

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