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: audit
Event: template_created
Version: 1

|
method required

Title: The HTTP Method of address register operation
Type: string
Example:
POST

uri required

Title: The URI of address register operation
Type: string
Example:
/v1/templates

email required

Title: The email of operator that registered address
Type: string
Example:
[email protected]

roles required

Type: array

origin required

Title: The request origin of address register operation
Type: string
Example:
P2P
PAYMENTS

object required

Title: The object that represents the template creation register requested
Type: object

id required

Title: The template ID
Type: string
Example:
b22bc8ae-b178-4370-8164-e21154d88d87

org_id required

Title: The org ID
Type: string
Example:
TN-b22bc8ae-b178-4370-8164-e21154d88d87

name required

Title: The name of the template
Type: string
Example:
Template name

description

Title: The description of the template
Type: string
Example:
Template rules for legal person.

program_id required

Title: The program ID related to the rule template
Type: integer
Example:
137

entity_type required

Title: The entity type related to the rule template [legal_person, natural_person]
Type: string
Example:
legal_person

association required

Title: The association list
Type: array
Example:

[
    "account"
]
restriction_rules required

Type: array

name required

Title: The name of the rule
Type: string
Example:
balance-limit-10000-rule

description

Title: The description of the rule
Type: string
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
Example:
07000

conditions required

Type: array

attribute required

Title: The attribute to evaluate in the condition
Type: string
Example:
week_day

operator required

Title: Conditions operators
Type: string
Example:
nin

value required

Title: The value to compare
Type: string
Example:
monday,tuesday,wednesday,thursday,friday

deny_code required

Title: The deny code related to the restriction
Type: string
Example:
ERR_VAL_WEEK_DAY

custom_code

Title: Custom code
Description: Alphanumeric three-character custom code. This can be the alternative custom code. When the platform denies a control evaluation, it returns the custom code that provides the precise reason for the denial by the anti-fraud solution.
Type: string
Min length: 3
Max length: 3
Example:
A1B

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.
Type: string
Example:
FM
57
05

evaluation_order

Title: Order in which the control is evaluated. If this value is not provided, the control is evaluated after the controls with the configured evaluation_order value.
Type: integer
Example:
99

active

Title: The active state of the rule
Type: boolean
Example:
true

accumulator_rules required

Type: array

name required

Title: The name of the rule
Type: string
Example:
purchase-1M-rule

description

Title: The description of the rule
Type: string
Example:
This rule control the maximum amount that the user can spend.

processing_codes

Title: The list of processing codes for evaluating the conditions rules
Type: string
Example:
07000

type required

Title: The type of accumulator rule
Type: string
Example:
spending_limit

max_limit required

Title: The maximum spending limit
Type: integer
Example:
10000

limit_duration

Title: The limit period duration (ISO 8601 format) for the spending limit rule
Type: string
Example:
P1M

deny_code required

Title: The deny code related to the accumulator rule
Type: string
Example:
ERR_MAX_SPENDING_LIMIT

custom_code

Title: Custom code
Description: Alphanumeric three-character custom code. This can be the alternative custom code. When the platform denies a control evaluation, it returns the custom code that provides the precise reason for the denial by the anti-fraud solution.
Type: string
Min length: 3
Max length: 3
Example:
A1B

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.
Type: string
Example:
FM
57
05

evaluation_order

Title: Order in which the control is evaluated. If this value is not provided, the control is evaluated after the controls with the configured evaluation_order value.
Type: integer
Example:
99

active

Title: The active state of the rule
Type: boolean
Example:
true

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#",
    "type": "object",
    "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>",
    "required": [
        "method",
        "uri",
        "email",
        "roles",
        "origin",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "The HTTP Method of address register operation",
            "examples": [
                "POST"
            ]
        },
        "uri": {
            "type": "string",
            "title": "The URI of address register operation",
            "examples": [
                "/v1/templates"
            ]
        },
        "email": {
            "type": "string",
            "title": "The email of operator that registered address",
            "examples": [
                "[email protected]"
            ]
        },
        "roles": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "title": "The roles of operator that registered address",
            "examples": [
                "test1",
                "test2"
            ]
        },
        "origin": {
            "type": "string",
            "title": "The request origin of address register operation",
            "examples": [
                "P2P",
                "PAYMENTS"
            ]
        },
        "object": {
            "type": "object",
            "title": "The object that represents the template creation register requested",
            "required": [
                "id",
                "org_id",
                "name",
                "program_id",
                "entity_type",
                "association",
                "restriction_rules",
                "accumulator_rules"
            ],
            "properties": {
                "id": {
                    "title": "The template ID",
                    "type": "string",
                    "examples": [
                        "b22bc8ae-b178-4370-8164-e21154d88d87"
                    ]
                },
                "org_id": {
                    "title": "The org ID",
                    "type": "string",
                    "examples": [
                        "TN-b22bc8ae-b178-4370-8164-e21154d88d87"
                    ]
                },
                "name": {
                    "title": "The name of the template",
                    "type": "string",
                    "examples": [
                        "Template name"
                    ]
                },
                "description": {
                    "title": "The description of the template",
                    "type": "string",
                    "examples": [
                        "Template rules for legal person."
                    ]
                },
                "program_id": {
                    "title": "The program ID related to the rule template",
                    "type": "integer",
                    "examples": [
                        137
                    ]
                },
                "entity_type": {
                    "title": "The entity type related to the rule template [legal_person, natural_person]",
                    "type": "string",
                    "examples": [
                        "legal_person"
                    ]
                },
                "association": {
                    "title": "The association list",
                    "type": "array",
                    "items": {
                        "type": "string",
                        "title": "The association item [account, card, customer]",
                        "examples": [
                            "account"
                        ]
                    }
                },
                "restriction_rules": {
                    "title": "The restriction rules list",
                    "type": "array",
                    "items": {
                        "type": "object",
                        "required": [
                            "name",
                            "conditions",
                            "deny_code"
                        ],
                        "properties": {
                            "name": {
                                "title": "The name of the rule",
                                "type": "string",
                                "examples": [
                                    "balance-limit-10000-rule"
                                ]
                            },
                            "description": {
                                "title": "The description of the rule",
                                "type": "string",
                                "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",
                                "examples": [
                                    "07000"
                                ]
                            },
                            "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",
                                            "examples": [
                                                "week_day"
                                            ]
                                        },
                                        "operator": {
                                            "title": "Conditions operators",
                                            "type": "string",
                                            "examples": [
                                                "nin"
                                            ]
                                        },
                                        "value": {
                                            "title": "The value to compare",
                                            "type": "string",
                                            "examples": [
                                                "monday,tuesday,wednesday,thursday,friday"
                                            ]
                                        }
                                    }
                                }
                            },
                            "deny_code": {
                                "title": "The deny code related to the restriction",
                                "type": "string",
                                "examples": [
                                    "ERR_VAL_WEEK_DAY"
                                ]
                            },
                            "custom_code": {
                                "title": "Custom code",
                                "description": "Alphanumeric three-character custom code. This can be the alternative custom code. When the platform denies a control evaluation, it returns the custom code that provides the precise reason for the denial by the anti-fraud solution.",
                                "type": "string",
                                "minLength": 3,
                                "maxLength": 3,
                                "examples": [
                                    "A1B"
                                ]
                            },
                            "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.",
                                "type": "string",
                                "examples": [
                                    "FM",
                                    "57",
                                    "05"
                                ]
                            },
                            "evaluation_order": {
                                "title": "Order in which the control is evaluated. If this value is not provided, the control is evaluated after the controls with the configured `evaluation_order` value.",
                                "type": "integer",
                                "minimum": 0,
                                "maximum": 99,
                                "examples": [
                                    99
                                ]
                            },
                            "active": {
                                "title": "The active state of the rule",
                                "type": "boolean",
                                "examples": [
                                    true
                                ]
                            }
                        }
                    }
                },
                "accumulator_rules": {
                    "title": "The accumulator rules list",
                    "type": "array",
                    "items": {
                        "type": "object",
                        "required": [
                            "name",
                            "type",
                            "max_limit",
                            "deny_code"
                        ],
                        "properties": {
                            "name": {
                                "title": "The name of the rule",
                                "type": "string",
                                "examples": [
                                    "purchase-1M-rule"
                                ]
                            },
                            "description": {
                                "title": "The description of the rule",
                                "type": "string",
                                "examples": [
                                    "This rule control the maximum amount that the user can spend."
                                ]
                            },
                            "processing_codes": {
                                "title": "The list of processing codes for evaluating the conditions rules",
                                "type": "string",
                                "examples": [
                                    "07000"
                                ]
                            },
                            "type": {
                                "title": "The type of accumulator rule",
                                "type": "string",
                                "examples": [
                                    "spending_limit"
                                ]
                            },
                            "max_limit": {
                                "title": "The maximum spending limit",
                                "type": "integer",
                                "examples": [
                                    10000
                                ]
                            },
                            "limit_duration": {
                                "title": "The limit period duration (ISO 8601 format) for the spending limit rule",
                                "type": "string",
                                "examples": [
                                    "P1M"
                                ]
                            },
                            "deny_code": {
                                "title": "The deny code related to the accumulator rule",
                                "type": "string",
                                "examples": [
                                    "ERR_MAX_SPENDING_LIMIT"
                                ]
                            },
                            "custom_code": {
                                "title": "Custom code",
                                "description": "Alphanumeric three-character custom code. This can be the alternative custom code. When the platform denies a control evaluation, it returns the custom code that provides the precise reason for the denial by the anti-fraud solution.",
                                "type": "string",
                                "minLength": 3,
                                "maxLength": 3,
                                "examples": [
                                    "A1B"
                                ]
                            },
                            "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.",
                                "type": "string",
                                "examples": [
                                    "FM",
                                    "57",
                                    "05"
                                ]
                            },
                            "evaluation_order": {
                                "title": "Order in which the control is evaluated. If this value is not provided, the control is evaluated after the controls with the configured `evaluation_order` value.",
                                "type": "integer",
                                "minimum": 1,
                                "maximum": 99,
                                "examples": [
                                    99
                                ]
                            },
                            "active": {
                                "title": "The active state of the rule",
                                "type": "boolean",
                                "examples": [
                                    true
                                ]
                            }
                        }
                    }
                },
                "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",
                                    "examples": [
                                        "contactless-13245"
                                    ]
                                },
                                "description": {
                                    "title": "The description of the card level rule.",
                                    "description": "The complete rule description.",
                                    "type": "string",
                                    "examples": [
                                        "This rule control the maximum of contactless transactions"
                                    ]
                                },
                                "processing_codes": {
                                    "title": "The list of processing codes for evaluating the conditions rules.",
                                    "description": "The processing codes that defines when the rule should be applied.",
                                    "type": "string",
                                    "examples": [
                                        "07000"
                                    ]
                                },
                                "type": {
                                    "title": "The type of the card accumulator rule",
                                    "description": "The type of rule.",
                                    "type": "string",
                                    "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",
                                    "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",
                                    "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",
                                    "examples": [
                                        "ERR_MAX_CONTACTLESS_TRANSACTIONS"
                                    ]
                                },
                                "custom_code": {
                                    "title": "Custom code",
                                    "description": "Alphanumeric three-character custom code. This can be the alternative custom code. When the platform denies a control evaluation, it returns the custom code that provides the precise reason for the denial by the anti-fraud solution.",
                                    "type": "string",
                                    "minLength": 3,
                                    "maxLength": 3,
                                    "examples": [
                                        "A1B"
                                    ]
                                },
                                "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
                                    ]
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}