Skip to main content

Auto-collect payments

info

The Payment Schedules: Auto-collect Payments feature is in beta and open for public testing.

FinDock gives you fine-grained control over when and how payments are collected through payment schedules. With the addition of two new options, Auto Run and Auto Create, you can automatically collect payments over a fixed or unlimited timeframe. These options can be used independently or combined to auto-collect payments.

Automatically run payment schedules

The Auto Run option operates on the payment processor level. When enabled for a given payment processor and method combination, payment schedules with that combination are automatically run on the scheduled run date. Both the generate and process phases of the payment schedule are automatically triggered by Auto Run.

If you create a payment schedule that you want to run manually, such as a special end-of-the-month collection, you can select the “Exclude from Auto Run” option on the schedule configuration and run it manually by changing the schedule status.

Automatically create payment schedules

To automatically create Payment Schedules, configure a Recurring Payment Schedule.With the Auto Create option selected on a given schedule, FinDock automatically creates payment schedules according to the parameters you define on the recurring schedule.

Prerequisite: FinDock Heart Beat Apex job#

To automatically create and run payment schedules, FinDock requires the Heart Beat job to be scheduled.

Enabling automated payment schedule runs#

Automated collection can be configured per payment processor and payment method.

To enable Auto Run for a certain payment processor and method combination:

  1. Launch the FinDock app and click the Setup tab.
  2. Go to the ACTIVATE / DEACTIVATE tab and click Payment Method next to the processor you want to configure.
  3. Click the cog wheel next to the payment method you would like to automatically collect.
    Payment methods with auto-collect
  4. Click the Auto Run toggle and then Close.
    Auto Run enabled
  5. Check if the grey pause icon next to the payment method has turned into a blue play icon.
    Auto Run enabled for payment method

Once Auto Run is enabled, all payment schedules with the given processor and method combination are run automatically unless you explicitly exclude a payment schedule by selecting the “Exclude from Auto Run" checkbox on the schedule.

Enabling automated creation of payment schedules#

You can use recurring payment schedules to generate a fixed number of payment schedules (normal use) or to create an unlimited number of payment schedules (auto-collect use).

If you want to use a recurring payment schedule for auto-collection, create a new schedule and select the Auto Create option.

Auto Create on recurring payment schedule

When using Auto Create, there are two additional settings you need to define:

  • Collection Date Conflict Strategy: this determines how FinDock handles a collection date that falls outside business hours. The options are:
    • Collect on previous working day (default)
    • Collect on next working day
  • Run Date Conflict Strategy: this determines how FinDock handles a run date that falls outside business hours. The options are:
    • Collect on previous working day
    • Collect on next working day (default)

To check whether recurring payment schedules have been configured for a certain payment processor and method combination:

  1. Launch the FinDock app and click the Setup tab.
  2. Go to the ACTIVATE / DEACTIVATE tab and click Payment Method next to the processor you want to configure.
  3. Check the number in the circle under AUTOMATED COLLECTION. This indicates the number of configured recurring payment schedules configured.
    Auto Run enabled for payment method
  4. Click the cog wheel next to the payment method you would like to automatically collect.
  5. Under Automated creation of Payment Schedules - Recurring payment schedules that automatically create payment schedules, you will find a list of recurring payment schedules configured for this specific payment processor and method combination.
    Auto-collect configuration details