•Data Management Configuration
Summary
Script Name |
Process Scheduled Payments |
|
Minimum Supported Version |
7.7.0 |
|
Source Type |
Single Source |
|
Script Definitions |
Scheduled Payments to Process |
|
|
Warning Never use 'Dry Run' when payments are involved. It will send the payments to the gateway but not commit anything to the database, causing double-charges when you do run it. |
Use Case
The Process Scheduled Payments script processes unprocessed payments for today or earlier.
Source File Format
This script is run using a single .CSV or BI (saved as a text/csv 'Extract Tempate') source file.
The following image illustrates the structure required for the Scheduled Payments to Process:
The following table outlines the field mapping:
Column |
Required? |
Source Column Header |
Field Name |
UI Field Location |
1 |
Yes |
Order Number |
Order Number |
Customer Services - Order|Summary page |
2 |
Yes |
Payment ID |
N/A |
Used as a unique identifier by the script. |
3 |
Yes |
Schedule Date |
Schedule Date |
Customer Services - Order|Summary page |
4 |
Yes |
Payment Method Name |
Payment Method |
Customer Services - Order|Summary page |
5 |
Yes |
Transaction Amount |
Transaction Amount |
Customer Services - Order|Summary page |
How the Script Works
The following table outlines the actions and expected results of the script:
Condition |
Action |
Expected Results |
There are unprocessed scheduled payments with dates ranging from past to future. |
The script attempts to process all of the payments. |
Payments scheduled for today and earlier will be processed. Payments scheduled with future dates will not be processed. |
The payment method in the source file and the payment method on the customer do not match. |
The script attempts to process all of the payments. |
Only customer with matching payment methods will be updated. |
There are unprocessed scheduled payments using a variety of payment methods. |
The script attempts to process all of the payments. |
Only the scheduled payments using a credit card are processed. |
Data Management Configuration
The following outlines the data management job configuration:
•Data Management Job Name: Process Scheduled Payments
•Script Definition: Process Scheduled Payments
Job Criteria Section |
|
Field |
Field Values |
Payment Terminal |
This is required when using Tender Retail/PXP Solutions Limited (formerly ServeBase) |
User Role |
Specifies the role that will process the payments. This also determines the way that the payment will be allocated on the orders. The selected 'User Role' must be assigned to the user account on the Application Security - Users|Basic page (typically, the sched user). |
The following image is an example of the Data Management|Schedule page when creating a job using all of the available source files:
