browse
ZonePayments automatically runs several scripted processes to facilitate core product functionality. These processes are included in the ZonePayments bundle and work out-of-the-box.
Each scripted process is managed through a ZP Automation record where details of the ZP Process are defined. This includes when the automation runs and what population of records is processed.
The following ZP Automated Processes are available to run:
- Reconcile Payments
- Retrieve Payouts
- Process Payouts
- Process Authorizations
- Process Autopay
- Create Provider Refunds
- Record Sync
- Process Payment Links- Transaction
- Process Payment Links- Customer
ZP Automated Processes
To view and manage ZP Automated Processes running in your environment go to Setup > Zone Payments Setup > ZP Automated Processes. Below is an overview of how each ZP Process functions.
Reconcile Payments
Schedule: Hourly by default
This process retrieves any payment or refund records that have been created or updated in the payment provider since the last successful execution. Details from these records are then brought into NetSuite, creating or updating appropriate transaction and Payment Provider Activity records depending on various conditions.
Retrieve Payouts
Schedule: Daily by default
This process retrieves any payout records that have been created or updated in the payment provider since the last successful execution. These records are then brought into NetSuite, creating Payout Event records.
See Payouts and Deposit Handling for more information.
Process Payouts
Schedule: Daily by default
This process creates Deposit records in NetSuite for any unprocessed Payout Events.
See Payouts and Deposit Handling for more information.
Process Authorizations
Schedule: Daily by default
This process creates Payment Authorization records for any payments that were submitted by the customer with ‘Save Payment Method for Automatic Payment’ checked. It contains relevant information that can be used by subsequent processes to automatically generate future payments.
See the Autopay for more information.
Process Autopay
Schedule: Daily by default
This process identifies Invoices that have reached their due date and verifies if a Payment Authorization applies to the Invoice. If the due Invoice has an applicable Payment Authorization, a payment is created in the payment provider for the remaining amount due.
See Autopay more information.
Create Provider Refunds
Schedule: Hourly by default
This process searches for any outstanding Credit Memos with ZP Issue Refund checked and issues a refund in the payment provider account.
See Refunds for more information.
Record Sync
Schedule: Daily by default
This process matches records between your payment provider and NetSuite. This references the settings specified on the Record Sync Config record.
See Record Syncing for more information.
Process Payment Links - Transaction
Schedule: Not scheduled by default
This process generates Payment Links on existing open Transactions. This process is typically run during initial setup or whenever new Payment Profiles are created.
See Generating Payment Links for more information.
Process Payment Links - Customer
Schedule: Not scheduled by default
This process generates Payment Links on existing Customer records. This process is typically run during initial setup or whenever new Payment Profiles are created.
See Generating Payment Links for more information.
Scheduling an Automation
To update the frequency of when an Automation runs:
- Go to Setup > Zone Payments Setup > ZP Automated Processes to view the list of Automations.
- Click Edit next to the specific Automation you would like to update.
- In the Interval field, select the recurrence interval you would like the Automation to execute. E.g. Hours, Days, Weeks, etc.
- In the Frequency field, select how frequently you would like the Automation to execute based on the selected interval. For example if you want the Automation to execute every 3 hours, you would select ‘Hours’ as the Interval, and '3' as the Frequency.
- In the Start Date field, populate a Date and Time when the Automation should execute for the first time.
- Click Save to save any changes you’ve made.
Other Automation Settings
Default Window: If there is no Start Date for an automated process then this will be the default number of days in the past to get information. For Automations, the default window is 60 days. For example, the ‘Retrieve Payouts' Automation will gather the previous 60 days of Payout activity from the Payment Provider, to create NetSuite Deposits.
Search: The Saved Search selected in this field defines the population of records to be processed. The Search Link is a link to the selected Saved Search. You are able to modify the default Automation Searches to fit your needs. The Search must not use Summary Criteria or Summarized Results and must include a results column that contains the Internal ID of the record.