Payscript

Payscript is a domain specific language (DSL) derived from Groovy. Using the Groovy syntax, with additional built-in functions, it is able to cover the functionality needed to operate in the environment of a financial services provider.

For Syntax, this version does not differ from Groovy. please consult the Groovy syntax reference.

Script Structure

PayScript has two special structures, beyond the programming logic; A trigger definition and script parameters. The trigger specifies what type of event will cause the script to run. When an automation is created with the script, the parameters of the trigger will be specified. For example, if the script’s trigger type is “time”, the parameters would be which date and time it should run on. Also during the creation of the automation, the script parameters required by the script will be supplied.

Script Parameter Definitions

The script parameters are values which will be used by the script but will be specified by the customer who creates an automation which uses this script. At that time they will be prompted for the values, much like the trigger parameters. Parameters are specified in the script using the following syntax:

"${PARAMETER_NAME}"

Where PARAMETER_NAME is to be replaced with the name of the parameter, as will be shown to the user during the creation of an automation using this script.

Logic

The logic section contains what the script needs to accomplish, utilizing groovy logic and the payscript built-in functions.

Concepts

These are the Quant Flow concepts as how they’re implemented by PayScript.

Automation

Automations are features powered by one or more PayScripts, which a customer can enable in their bank account. If the selected payscript uses a trigger type that requires trigger parameters, those need to be specified as part of creating the automation. If the selected payscript defines script parameters, those need to be specified as part of creating the automation.

Reserve

An abstract segregation of funds in a customer’s account with a name and a purpose, so that those funds can be considered unavailable for other purposes, effectively reserving them. Funds can be added to and removed from the reserve by the account owner, or by whoever the account owner has given consent to do this.