User Adjustable Parameters
Banking.Live's Rule Engine allows clients and their cardholders to utilize rules with user adjustable parameters. User Adjustable Parameters allow cardholders to individually override rule values set when the rule was created.
The transaction values available to be used with User Adjustable Parameters are:
- Number of transactions (No of Spends)
- DE6 threshold value (Spend Amount - Current)
- DE6 threshold value (Spend Amount - Historic)
- Aggregated amount threshold value (Spend Amount - Cumulative Total)
When making a value available as a User Adjustable Parameter, we define three things:
- Default value (
def): this is the parameter value the card associated to the rule inherits by default. - Minimum value (
min): this is the lowest value a cardholder can adjust the rule parameter value to. - Maximum value (
max): this is the highest value a cardholder can adjust a rule parameter value to.
User adjustable parameters use case
In this use case, a rule by default is configured to trigger if:
- the current transaction is an ATM withdrawal for 100.00 USD, and;
- there have been 3 or more ATM withdrawals (not including the current one) in the past 3 hours, and;
- the total amount of these transactions is exceeding 700.00 USD (including the current one).
In this use case the rule has been configured with the following parameter values:
|
|
Default value |
Minimum value |
Maximum value |
|---|---|---|---|---|
1 | Number of transactions (No of Spends) | 3 | 2 | 5 |
2 | DE6 threshold value (Spend Amount - Current) | 100.00 | 50.00 | 300.00 |
3 | Aggregated amount threshold value (Spend Amount - Cumulative Total) | 700.00 | 250.00 | 2000.00 |
Therefore, in this example a cardholder has the ability to adjust:
- No of Spends: to a value between 2 and 5 (inclusive)
- Spend Amount - Current: to a value between 50.00 and 300.00 (inclusive)
- Spend Amount - Cumulative Total: to a value between 250.00 and 2000.00 (inclusive)
How can I implement user adjustable parameters?
If you are looking at using rules with user adjustable parameters you can discuss this with our Implementation Team during onboarding.
Alternatively, if you are already live, you can reach out to your Client Executive or raise a ticket on our Customer Support platform.
- The initial rule is set up by Paymentology in PayControl. Dependent on what you are trying to achieve, Clients are required to provide Paymentology with:
- Number of transactions (No of Spends): default, minimum and maximum values
- DE6 threshold value (Spend Amount - Current): default, minimum and maximum values
- DE6 threshold value (Spend Amount - Historic): default, minimum and maximum values
- Aggregated amount threshold value (Spend Amount - Cumulative Total): default, minimum and maximum values
- Once the initial rule has been configured by Paymentology, you can use the associated API endpoints List Rules, Lists rule function call parameters for a card and Set rule parameters for a card.
API endpoints
- List Rules: used to view the available adjustable parameters and their limits (
def,min,max) for a specific rule. - Lists rule function call parameters for a card: used to view the individually set parameters for a specific card.
- Set rule parameters for a card: used to set parameters for a specific card. If parameters are not set, the default values are used.
Updating selected rule parameters for a card
All the parameters configured as adjustable have to be adjusted.
Given all parameters configured as adjustable have to be adjusted, when using the Set rule parameters for a card API endpoint, you must pass the value null if the default value should be used for the specific parameter.
For example:
Rule (rule_id ) 1 has been configured with the following values:
|
|
Default |
Lower bound |
Upper bound |
|---|---|---|---|---|
1 | Number of transactions (No of Spends) | 3 | 2 | 5 |
2 | DE6 threshold value (Spend Amount - Current) | 100.00 | 50.00 | 300.00 |
3 | Aggregated amount threshold value (Spend Amount - Cumulative Total) | 700.00 | 250.00 | 2000.00 |
The cardholder wishes to change the maximum spend amount they can spend on a single transaction to $75.00. Therefore, the request call would be:
{
"api_call_unique_identifier": "438574845790657485",
"client_id": 123456,
"user_id": "userId:[email protected]",
"token": 123456789,
"rule_id": 1,
"param_index": [1,2,3],
"param_value": [null,75.00,null]
}{
"header": {
"error_id": 0,
"error_desc": "success"
},
"body": {}
}Updated 7 months ago
