Dormancy configuration created

Type: object
Domain: corporate
Event: dormancy_config_creation
Version: 1

id required

Title: Dormancy configuration identifier
Description: Dormancy configuration unique identifier generated by Pismo.
Type: string
Example:
46f152b4-1cfd-4d75-a198-ae25fde7d255

check_time required

Title: Dormancy check time
Description: The dormancy check time in the division's/program's timezone.
Type: string
Min length: 1
Max length: 8
Example:
20:10:05

target_type required

Title: Target type
Description: Indicates the type of level to which the dormancy config is attached.
Type: string
Min length: 1
Max length: 8
Example:
DIVISION
PROGRAM

target_id required

Title: Target ID
Description: Unique ID used to identify the level the dormancy config is attached to in the Pismo platform APIs.
Type: string
Min length: 1
Max length: 60
Example:
1d22e668-a857-4455-aee7-dbe888f4bf2b

statuses required

Type: array

status required

Title: Status name
Description:
It only accepts the following dormancy values:
INACTIVE: When the account is inactive.
DORMANT: When the account is dormant.
UNCLAIMED: When the account is unclaimed.
Type: string
Min length: 1
Max length: 20
Example:
DORMANT

days required

Title: Number of days
Description: Days of inactivity required to transition the account to the specified status. Each value specified must be unique in the status object.
Type: integer
Example:
180

reason_id required

Title: Reason unique identifier
Description: The reason associated with the specified status.
Type: integer
Example:
10

reactivation_with_last_restriction

Title: Reactivation with last restriction
Description: Indicates whether the account should be reactivated to normal with its last manual change restriction.
Type: boolean
Example:
true

restrictions

Title: Restrictions
Description: List of objects that contain the information pertaining to account dormancy restrictions.
Type: array

current_reason_id required

Description: The dormancy configuration checks whether the current account reason_id is the same as the current account reason. If they are different, the dormancy configuration sets the reason to the value of the reason_id field.
Type: integer
Example:
13

new_reason_id required

Description: The reason_id related to that status if the current account reason_id value is the same as current_reason_id.
Type: integer
Example:
16

dormancy_config_validity required

Title: Dormancy-config validity date
Description: Object for the validity date of the dormancy configuration.
Type: object

start required

Title: Dormancy-config validity start date
Description: The effective date of the configuration in UTC format.
Type: string
Max length: 24
Example:
2023-08-14T22:14:48.636Z

end

Title: Dormancy-config validity end date
Description: The end date of the configuration in UTC format.
Type: string
Max length: 24
Example:
2023-09-14T22:14:48.636Z

dormant_processing_codes

Type: array or null
Min length: 1
Max length: 6
Example:
[
    "100000",
    "100001"
]

deny_forced_transaction_reactivation

Title: Deny Forced Transaction Reactivation
Description: Indicates whether an account under that dormancy configuration should be reactivated when a forced transaction is made to that account.
Type: boolean
Example:
true

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Dormancy configuration created",
    "required": [
        "id",
        "check_time",
        "target_type",
        "target_id",
        "statuses",
        "dormancy_config_validity"
    ],
    "properties": {
        "id": {
            "type": "string",
            "title": "Dormancy configuration identifier",
            "description": "Dormancy configuration unique identifier generated by Pismo.",
            "examples": [
                "46f152b4-1cfd-4d75-a198-ae25fde7d255"
            ]
        },
        "check_time": {
            "type": "string",
            "title": "Dormancy check time",
            "description": "The dormancy check time in the division's/program's timezone.",
            "minLength": 1,
            "maxLength": 8,
            "examples": [
                "20:10:05"
            ]
        },
        "target_type": {
            "type": "string",
            "title": "Target type",
            "description": "Indicates the type of level to which the dormancy config is attached.",
            "minLength": 1,
            "maxLength": 8,
            "examples": [
                "DIVISION",
                "PROGRAM"
            ]
        },
        "target_id": {
            "type": "string",
            "title": "Target ID",
            "description": "Unique ID used to identify the level the dormancy config is attached to in the Pismo platform APIs.",
            "minLength": 1,
            "maxLength": 60,
            "examples": [
                "1d22e668-a857-4455-aee7-dbe888f4bf2b"
            ]
        },
        "statuses": {
            "title": "Dormancy configuration status list",
            "description": "List of objects that contains all the information pertinent to valid dormancy statuses.",
            "type": "array",
            "items": {
                "type": "object",
                "required": [
                    "status",
                    "days",
                    "reason_id"
                ],
                "properties": {
                    "status": {
                        "type": [
                            "string"
                        ],
                        "title": "Status name",
                        "description": "\n\nIt only accepts the following dormancy values:\n\n<span style='font-weight:bold'>INACTIVE:</span> When the account is inactive.\n\n<span style='font-weight:bold'>DORMANT:</span> When the account is dormant.\n\n<span style='font-weight:bold'>UNCLAIMED:</span> When the account is unclaimed.",
                        "minLength": 1,
                        "maxLength": 20,
                        "examples": [
                            "DORMANT"
                        ]
                    },
                    "days": {
                        "type": "integer",
                        "title": "Number of days",
                        "description": "Days of inactivity required to transition the account to the specified status. Each value specified must be unique in the status object.",
                        "minimum": 1,
                        "examples": [
                            180
                        ]
                    },
                    "reason_id": {
                        "type": "integer",
                        "title": "Reason unique identifier",
                        "description": "The reason associated with the specified status.",
                        "minimum": 1,
                        "maximum": 99999999999,
                        "examples": [
                            10
                        ]
                    },
                    "reactivation_with_last_restriction": {
                        "type": "boolean",
                        "title": "Reactivation with last restriction",
                        "description": "Indicates whether the account should be reactivated to `normal` with its last manual change restriction.",
                        "examples": [
                            true
                        ]
                    },
                    "restrictions": {
                        "type": "array",
                        "title": "Restrictions",
                        "description": "List of objects that contain the information pertaining to account dormancy restrictions.",
                        "required": [
                            "current_reason_id",
                            "new_reason_id"
                        ],
                        "properties": {
                            "current_reason_id": {
                                "type": "integer",
                                "description": "The dormancy configuration checks whether the current account `reason_id` is the same as the current account reason. If they are different, the dormancy configuration sets the reason to the value of the `reason_id` field.",
                                "examples": [
                                    13
                                ]
                            },
                            "new_reason_id": {
                                "type": "integer",
                                "description": "The `reason_id` related to that status if the current account `reason_id` value is the same as `current_reason_id`.",
                                "examples": [
                                    16
                                ]
                            }
                        }
                    }
                }
            }
        },
        "dormancy_config_validity": {
            "type": "object",
            "title": "Dormancy-config validity date",
            "description": "Object for the validity date of the dormancy configuration.",
            "required": [
                "start"
            ],
            "properties": {
                "start": {
                    "type": "string",
                    "title": "Dormancy-config validity start date",
                    "description": "The effective date of the configuration in UTC format.",
                    "maxLength": 24,
                    "examples": [
                        "2023-08-14T22:14:48.636Z"
                    ]
                },
                "end": {
                    "type": "string",
                    "title": "Dormancy-config validity end date",
                    "description": "The end date of the configuration in UTC format.",
                    "maxLength": 24,
                    "examples": [
                        "2023-09-14T22:14:48.636Z"
                    ]
                }
            }
        },
        "dormant_processing_codes": {
            "title": "Dormant processing code list",
            "description": "List of processing codes that prevent account reactivation. When there are financial transactions in an account that are made with any of these codes, the account cannot be reactivated.",
            "type": [
                "array",
                "null"
            ],
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 6,
                "examples": [
                    "100000",
                    "100001"
                ]
            }
        },
        "deny_forced_transaction_reactivation": {
            "type": "boolean",
            "title": "Deny Forced Transaction Reactivation",
            "description": "Indicates whether an account under that dormancy configuration should be reactivated when a forced transaction is made to that account.",
            "examples": [
                true
            ]
        }
    }
}

{
    "id": "46f152b4-1cfd-4d75-a198-ae25fde7d255",
    "check_time": "20:10:05",
    "target_type": "DIVISION",
    "target_id": "1d22e668-a857-4455-aee7-dbe888f4bf2b",
    "statuses": {
        "status": "DORMANT",
        "days": 180,
        "reason_id": 10,
        "reactivation_with_last_restriction": true,
        "restrictions": {
            "current_reason_id": 13,
            "new_reason_id": 16
        }
    },
    "dormancy_config_validity": {
        "start": "2023-08-14T22:14:48.636Z",
        "end": "2023-09-14T22:14:48.636Z"
    },
    "dormant_processing_codes": [
        "100000",
        "100001"
    ],
    "deny_forced_transaction_reactivation": true
}

Updated 3 days ago