Payment Schedules

Introduction

Payment Schedules allow you to create a series of forward-looking, scheduled Transactions based on criteria you define through our EZ preset or advanced fields. You can:

  1. Relate the payment schedule to any object (standard/custom).

  2. Auto captures payments.

  3. Capture a valid Payment Method through the terminal that updates all related Transactions.

  4. Automatically request payment through PayLink.

  5. Create an advanced payment schedule for unique due dates.


Parent Object Relationship

Payment Schedules are related to the parent object(s) you defined in the Blackthorn | Payments Setup Wizard. Each parent object has a lookup field automatically created and placed on the Payment Schedule's Page Layout. This allows you to relate your parent object(s) to your Payment Schedule and to add the Payment Schedules related list to your parent object(s).

Payment Schedules out-of-the-box has lookups (relationships) to both Account and Contact objects. Just add the Payment Schedule related list to your Account and/or Contact Page Layouts.


Create an EZ Preset Payment Schedule

The EZ Preset process is used for creating simple Payment Schedules.

  • Navigate to our Payment Schedule object.

Lightning: Click on the App Launcher | Under "All Items" | Click on Payment Schedules.

Classic: Click on "All Tabs" ("+" icon in the top right) | Click on Payment Schedules.

  • Click "New".

The best feature of our Payment Schedule object is the ability to mix and match the fields you enter for generating scheduled Transactions. There are certain required fields (not marked required on the Page Layout) that need to be filled in when creating an "EZ Preset" Payment Schedule.

Required Fields

  • EZ Preset: This field determines the frequency of each Transaction with their Due Date.

  • Start Date: This date determines when the Payment Schedule should start. This date is the first Transaction's or the subsequent Transaction's if the first Transaction was captured immediately, Due Date.

  • End Date or Count: Either of these fields will determine the number of Transactions that need to be created.

  • Each Amount or Total Amount: Either of these fields will determine the amount of each Transaction.

  • Currency

Optional Fields

  • Initial Amount: First Transaction amount (for example initial fee + monthly amount) may be different than the other recurring payments.
    If you use this field, you only need to enter in Each Amount OR Total Amount, but not both.

  • Payment Method Add the customer's related Payment Method if you want to automatically process the generated Transactions based on their due date. You can also use our PayLink feature where you would leave the Payment Method field blank and request payment through one of the Transaction's PayLinks. Once the customer pays through that link, ALL related Transactions and the Payment Schedule's Payment Method will be updated. Click here for additional information on PayLink.

  • Account and Contact: If these fields are left blank and the related Payment Method's Account and Contact fields have a value, they will automatically populate onto the Payment Schedule.

  • Schedule Status: "Draft" and "Generate" need to be set manually (or defaulted). The rest of the picklist values are set automatically based on the status of related Transactions. To generate the Transactions for your Payment Schedule, the Schedule Status needs to be set to "Generate". That triggers the system to create all Transactions based on your Payment Schedule's EZ Preset and/or advanced fields.

  • Payment Status: This field is updated automatically. Do not change.

  • Balance Paid, Balance Due, and Next Payment Date: Are automatically set roll-up fields from the related Transactions.

  • Capture First Transaction Now: If there is a related Payment Method and the Schedule Status = "Generate", the first Transaction will be captured immediately through a real-time API call to Stripe.

  • Auto-Process Transactions: This field is checked by default. Once related Transactions are created, each one will auto-process based on their due date.
    A valid Payment Method is needed in order to auto-process the Transaction. See our transaction documentation for more information.

  • Click "Save".


Create an Advanced Payment Schedule

There are additional use cases where the Payment Schedule's frequency needs to be more complex than what is provided in the "EZ Preset" fields and for those use cases, you will want to use the advanced fields.

You will still need to enter in all the required and optional fields above with the exception of the EZ Preset field. That field is being replaced by all the advanced schedule fields.

For example, if your Payment Schedule needs to capture a payment once every three weeks, you would use our advanced schedule fields.

Repeats = Weekly.
Frequency = 3; Showing each Transaction's Due Date will be three weeks apart.

As you see in the below images, a Payment Schedule was created using the advanced fields Repeats and Frequency instead of the EZ Preset field because I needed to capture a payment every three weeks.

  • Keep in mind, if you did not add a valid Payment Method, nor requested for payment through PayLink the related Transactions will NOT capture a payment from your customer.

Open-ended Payment Schedules

Open-Ended Payment Schedules are single amounts captured over and over again, with no ending date defined. The Payment Schedule will continue until you close it.


Roll-up/Roll-down Features

Payment Method

From the Payment Schedule: Updating the Payment Method updates all related "Open" Transactions. For example, if a customer wants to change their Payment Method at any time during the schedule, just update the Payment Method field and the remaining "Open" Transactions will be updated.

From the Related Transaction: Updates to the Payment Method on an "Open" Transaction are rolled up to the related Payment Schedule, then rolled-down to all other "Open" related Transactions. For example, if a customer updates their Payment Method through PayLink on one Transaction, all other related Transactions and the Payment Schedule's Payment Method will be updated unless the Don't Auto-Update Payment Method field is checked.

Account and Contact Lookup Fields

From the Payment Schedule: If the Account and/or Contact lookup fields are populated when the Payment Schedule was first created or edited, all related "Open" Transaction's Account and/or Contact will be populated or updated.


Next Steps


Troubleshooting/FAQ

If you have received an error with your Payment Schedule or have a question, please view our Blackthorn | Payments Troubleshooting and Frequently Asked Questions. If you still have Payment Schedule questions, please contact Blackthorn Support. We're happy to help!