Flex control template created
This event occurs when the platform creates a flex controls template. The event contains full template information. To create a flex controls template, use Pismo Control Center or contact the Pismo support representative.
More information: Flexible transaction controls
Type: object
Domain: rules
Event: template_created
Version: 1
accumulator_rules
Type: array
deny_code required
Title: The deny code related to the accumulator rule
Type: string
Min length: 1
Max length: 50
Example:
ERR_MAX_SPENDING_LIMITmax_limit required
Title: The maximum spending limit
Type: integer
Example:
10000name required
Title: The name of the rule
Type: string
Min length: 1
Max length: 50
Example:
purchase-1M-ruletype required
Title: The type of accumulator rule
Type: string
Min length: 1
Max length: 14
Example:
spending_limitactive
Title: The active state of the rule
Type: boolean
Example:
truedescription
Title: The description of the rule
Type: string
Min length: 1
Max length: 200
Example:
This rule control the maximum amount that the user can spend.limit_duration
Title: The limit period duration (ISO 8601 format) for the spending limit rule
Type: string
Min length: 1
Max length: 5
Example:
P1Mprocessing_codes
Title: The list of processing codes for evaluating the conditions rules
Type: string
Min length: 1
Max length: 6
Example:
07000
association required
Title: The association list
Type: array
Example:[ "account" ]
entity_type required
Title: The entity type related to the rule template [legal_person, natural_person]
Type: string
Min length: 1
Max length: 14
Example:
legal_person
id required
Title: The template ID
Type: string
Min length: 1
Max length: 96
Example:
b22bc8ae-b178-4370-8164-e21154d88d87
name required
Title: The name of the template
Type: string
Min length: 1
Max length: 50
Example:
Template name
org_id required
Title: The org ID
Type: string
Min length: 1
Max length: 1024
Example:
TN-b22bc8ae-b178-4370-8164-e21154d88d87
program_id required
Title: The program ID related to the rule template
Type: integer
Example:
137
restriction_rules
Type: array
conditions required
Type: array
attribute required
Title: The attribute to evaluate in the condition
Type: string
Min length: 1
Max length: 22
Example:
week_dayoperator required
Title: Conditions operators
Type: string
Min length: 1
Max length: 3
Example:
ninvalue required
Title: The value to compare
Type: string
Min length: 1
Max length: 1024
Example:
monday,tuesday,wednesday,thursday,fridaydeny_code required
Title: The deny code related to the restriction
Type: string
Min length: 1
Max length: 50
Example:
ERR_VAL_WEEK_DAYname required
Title: The name of the rule
Type: string
Min length: 1
Max length: 50
Example:
balance-limit-10000-ruleactive
Title: The active state of the rule
Type: boolean
Example:
truedescription
Title: The description of the rule
Type: string
Min length: 1
Max length: 200
Example:
This rule restricts the transaction when balance account is greather than 10000, this rule is used to deny the transaction for law reasons.processing_codes
Title: The list of processing codes for evaluating the conditions rules
Type: string
Min length: 1
Max length: 6
Example:
07000
description
Title: The description of the template
Type: string
Min length: 1
Max length: 200
Example:
Template rules for legal person.
card
Title: The card level controls.
Description: The structure that contains the accumulators at the card level.
Type: object
{
"$schema": "http://json-schema.org/draft-07/schema",
"required": [
"accumulator_rules",
"association",
"entity_type",
"id",
"name",
"org_id",
"program_id",
"restriction_rules"
],
"title": "Flex control template created",
"description": "This event occurs when the platform creates a flex controls template. The event contains full template information. To create a flex controls template, use Pismo Control Center or contact the Pismo support representative. <br>More information: <a href='https://developers.pismo.io/pismo-docs/docs/flex-controls' target='_blank'>Flexible transaction controls</a>",
"type": "object",
"properties": {
"accumulator_rules": {
"title": "The accumulator rules list",
"type": "array",
"items": {
"type": "object",
"required": [
"deny_code",
"max_limit",
"name",
"type"
],
"properties": {
"deny_code": {
"title": "The deny code related to the accumulator rule",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"ERR_MAX_SPENDING_LIMIT"
]
},
"max_limit": {
"title": "The maximum spending limit",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
10000
]
},
"name": {
"title": "The name of the rule",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"purchase-1M-rule"
]
},
"type": {
"title": "The type of accumulator rule",
"type": "string",
"minLength": 1,
"maxLength": 14,
"examples": [
"spending_limit"
]
},
"active": {
"title": "The active state of the rule",
"type": "boolean",
"examples": [
true
]
},
"description": {
"title": "The description of the rule",
"type": "string",
"minLength": 1,
"maxLength": 200,
"examples": [
"This rule control the maximum amount that the user can spend."
]
},
"limit_duration": {
"title": "The limit period duration (ISO 8601 format) for the spending limit rule",
"type": "string",
"minLength": 1,
"maxLength": 5,
"examples": [
"P1M"
]
},
"processing_codes": {
"title": "The list of processing codes for evaluating the conditions rules",
"type": "string",
"minLength": 1,
"maxLength": 6,
"examples": [
"07000"
]
}
}
}
},
"association": {
"title": "The association list",
"type": "array",
"items": {
"type": "string",
"title": "The association item",
"examples": [
"account"
]
}
},
"entity_type": {
"title": "The entity type related to the rule template [legal_person, natural_person]",
"type": "string",
"minLength": 1,
"maxLength": 14,
"examples": [
"legal_person"
]
},
"id": {
"title": "The template ID",
"type": "string",
"minLength": 1,
"maxLength": 96,
"examples": [
"b22bc8ae-b178-4370-8164-e21154d88d87"
]
},
"name": {
"title": "The name of the template",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"Template name"
]
},
"org_id": {
"title": "The org ID",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"TN-b22bc8ae-b178-4370-8164-e21154d88d87"
]
},
"program_id": {
"title": "The program ID related to the rule template",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
137
]
},
"restriction_rules": {
"title": "The restriction rules list",
"type": "array",
"items": {
"type": "object",
"required": [
"conditions",
"deny_code",
"name"
],
"properties": {
"conditions": {
"title": "The rule conditions",
"type": "array",
"items": {
"type": "object",
"required": [
"attribute",
"operator",
"value"
],
"properties": {
"attribute": {
"title": "The attribute to evaluate in the condition",
"type": "string",
"minLength": 1,
"maxLength": 22,
"examples": [
"week_day"
]
},
"operator": {
"title": "Conditions operators",
"type": "string",
"minLength": 1,
"maxLength": 3,
"examples": [
"nin"
]
},
"value": {
"title": "The value to compare",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"monday,tuesday,wednesday,thursday,friday"
]
}
}
}
},
"deny_code": {
"title": "The deny code related to the restriction",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"ERR_VAL_WEEK_DAY"
]
},
"name": {
"title": "The name of the rule",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"balance-limit-10000-rule"
]
},
"active": {
"title": "The active state of the rule",
"type": "boolean",
"examples": [
true
]
},
"description": {
"title": "The description of the rule",
"type": "string",
"minLength": 1,
"maxLength": 200,
"examples": [
"This rule restricts the transaction when balance account is greather than 10000, this rule is used to deny the transaction for law reasons."
]
},
"processing_codes": {
"title": "The list of processing codes for evaluating the conditions rules",
"type": "string",
"minLength": 1,
"maxLength": 6,
"examples": [
"07000"
]
}
}
}
},
"description": {
"title": "The description of the template",
"type": "string",
"minLength": 1,
"maxLength": 200,
"examples": [
"Template rules for legal person."
]
},
"card": {
"title": "The card level controls.",
"description": "The structure that contains the accumulators at the card level.",
"type": "object",
"required": [
"accumulator_rules"
],
"accumulator_rules": {
"title": "The card accumulator controls list.",
"description": "The control accumulator rules at the card level.",
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"type",
"deny_code",
"reset_strategy"
],
"properties": {
"name": {
"title": "The name of the rule",
"description": "The name that describes the rule.",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"contactless-13245"
]
},
"description": {
"title": "The description of the card level rule.",
"description": "The complete rule description.",
"type": "string",
"minLength": 1,
"maxLength": 200,
"examples": [
"This rule control the maximum of contactless transactions"
]
},
"processing_codes": {
"title": "The list of processing codes for evaluating the conditions rules",
"type": "string",
"minLength": 1,
"maxLength": 6,
"examples": [
"07000"
]
},
"type": {
"title": "The type of the card accumulator rule",
"description": "The type of rule.",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"cumulative_limit"
]
},
"max_amount": {
"title": "The maximum amount. Either this field or max_transactions is required.",
"description": "The maximum cumulative amount that will be allowed. Either this field or max_transactions is required.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
100000
]
},
"max_transactions": {
"title": "The maximum transactions. Either this field or max_amount is required.",
"description": "The maximum number of transactions that will be allowed. Either this field or max_amount is required.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
10
]
},
"deny_code": {
"title": "The deny code related to the accumulator rule",
"description": "The defined deny code that should be presented when the rule validation doesn't pass.",
"type": "string",
"minLength": 1,
"maxLength": 50,
"examples": [
"ERR_MAX_CONTACTLESS_TRANSACTIONS"
]
},
"response_code": {
"title": "Alphanumeric two-character response code. This can be the standard card network response code or an alternative custom response code. When the platform denies a control evaluation, it returns the response code that provides the precise reason for the denial by the card network or anti-fraud solution.",
"description": "This can be the standard card network response code or an alternative custom response code. When the platform denies a control evaluation, it returns the response code that provides the precise reason for the denial by the card network or anti-fraud solution.",
"type": "string",
"examples": [
"FM",
"57",
"05"
]
},
"evaluation_order": {
"title": "Order in which the rule is evaluated.",
"description": "If this value is not provided, the rule is evaluated after the rules with the configured `evaluation_order` value.",
"type": "integer",
"minimum": 1,
"maximum": 99,
"examples": [
99
]
},
"conditions": {
"title": "The card level rule conditions",
"description": "The conditions that validate if the rule should be applied or not.",
"type": "array",
"items": {
"type": "object",
"required": [
"attribute",
"operator",
"value"
],
"properties": {
"attribute": {
"title": "The attribute to evaluate in the condition",
"description": "The attribute that should identify which field is related to the condition.",
"type": "string",
"examples": [
"is_password_present"
]
},
"operator": {
"title": "Conditions operators",
"description": "The condition operator that should be considered in the condition validation.",
"type": "string",
"examples": [
"eq"
]
},
"value": {
"title": "The value to compare",
"description": "The value that should contains the value to be validated in the condition.",
"type": "string",
"examples": [
"true",
"false"
]
}
}
}
},
"reset_strategy": {
"title": "The card rule accumulators reset strategy",
"description": "The defined strategy that will be considered to reset, increase or decrease the rule accumulators.",
"type": "object",
"required": [
"reset_trigger"
],
"properties": {
"reset_trigger": {
"title": "The trigger that should reset the card rule accumulators",
"description": "The trigger that should be considered to reset the control accumulators.",
"type": "object",
"required": [
"is_password_present"
],
"properties": {
"is_password_present": {
"title": "The is_password_present flag",
"description": "The flag property that identifies if the transaction was contactless or not.",
"type": "string",
"examples": [
"false, true"
]
}
}
}
}
},
"active": {
"title": "The active state of the rule",
"description": "The current active control state",
"type": "boolean",
"examples": [
true
]
}
}
}
}
}
}
}
Updated 15 days ago