Download Transactions

There are two ways to configure this download. The first way is to set up a Get Scheduled Payments job to run every night. This can be done under Admin Tools > Settings > Jobs Administration. This job will run each night (or when you decide you want it to run) and create batches and transactions for new payments.

Note

Don't Forget To Set Up The Download Job
It's important to remember to set up the Get Scheduled Payments job if you want the transactions to download automatically (highly recommended).

The download job has a few settings that you should review. These include:

  1. Batch Name Prefix: When the transactions are downloaded from the gateway, they're assigned to a batch. You can configure the names of these batches to all start with a certain prefix.
  2. Days Back: The number of previous days that the download job should use when querying the gateway for processed transactions. We recommend a value of seven. This allows for times that the job may not run every day. There is no risk in downloading the same transaction on multiple days as Rock keeps track of which transactions have already been added.
  3. Receipt Email: Each time a new transaction is downloaded for a person, Rock can send them a receipt of that transaction. Use this setting to specify the system communication that should be sent when new transactions are downloaded.
  4. Failed Payment Email: You can send a communication to specific recipients if a scheduled payment fails. Choose which system communication you want to send from the dropdown menu.
  5. Failed Payment Workflow: You can launch an optional workflow if a scheduled payment fails. Choose the workflow you want to run in this field.

You can also choose to manually download the new payments from the payment processor. You can do this under Finance > Download Payments. This does the same thing as the Rock job but requires you to manually run the download. This block also has settings that are similar to the job settings for setting the batch prefix and email receipt.

Tip

Setting a Payment Reversal Notification Workflow
The Scheduled Job Detail screen also includes an option to trigger a workflow when a scheduled transaction is declined (called a "reversal"). You can configure the workflow to perform any necessary follow-up task, such as sending an automated communication. Simply configure the workflow in your General Settings, then select it from the Failed Payment Workflow dropdown menu.

Downloading transactions from the gateway is actually a bit trickier than you might think because of certain edge-cases and advanced features. We'll cover some of these next.

Recent Scheduled Transaction Changes

Consider this example. Ted has a scheduled transaction set that takes $120 out of his account every week and puts it to the General Fund account. Early in the morning the payment gateway creates a new transaction for this amount. Ted arrives at work and changes his giving to $100 per week. Finally, later in the day, the church's Get Scheduled Payments job runs and pulls that day's transactions down from the gateway. The gateway's transaction says it's for $120 but Rock's information only has $100 allocated. When this happens (certainly a rare edge-case) Rock will apply any extra amount to a default account. This default account is the first active account that does not have a parent account and where the current date falls between the account's start/end dates.

Naming Batches for Online Giving

The way that Rock calculates the Batch Name is by combining a batch prefix and a batch suffix. The prefix is usually set by a block or job setting (the default value used by the Utility Payment Entry block, Scheduled Payment Download block, Get Scheduled Payments job etc. is Online Giving). The suffix depends on the currency type (Tender Type Defined Type). If it is not a credit card transaction, then the currency type value is used (e.g., ACH). If it is a credit card transaction, then the Credit Card type value is used (e.g., Visa, MasterCard, etc.). However, the Credit Card defined value also has a Batch Name Suffix that can be used to override this value. For example, if you want to combine Visa, MasterCard and Discover transactions into the same batch, you can set the Batch Name Suffix for all three to the same value (e.g., VMD) and then transactions of these types will be combined into the same batch.