Skip to content

Latest commit

 

History

History
18 lines (11 loc) · 1.68 KB

SweepSchedule.md

File metadata and controls

18 lines (11 loc) · 1.68 KB

SweepSchedule

Properties

Name Type Description Notes
type inline The schedule type. Possible values: * cron: push out funds based on a `cronExpression`. * daily: push out funds daily at 07:00 AM CET. * weekly: push out funds every Monday at 07:00 AM CET. * monthly: push out funds every first of the month at 07:00 AM CET. * balance: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` pull and when the source is a `merchantAccount` or `transferInstrument`. If the source is transferInstrument, merchant account identifier is still required, with which you want to process the transaction.
cronExpression kotlin.String A cron expression that is used to set the sweep schedule. The schedule uses the time zone of the balance account. For example, 30 17 * * MON schedules a sweep every Monday at 17:30. The expression must have five values separated by a single space in the following order: * Minute: 0-59 * Hour: 0-23 * Day of the month: 1-31 * Month: 1-12 or JAN-DEC * Day of the week: 0-7 (0 and 7 are Sunday) or MON-SUN. The following non-standard characters are supported: *, L, #, W and /. See crontab guru for more examples. Required when `type` is cron. [optional]

Enum: type

Name Value
type daily, weekly, monthly, balance, cron