Account status changed

This event occurs when account status changes.
Generated by: Update account status, Roll back account status
More information: Account status

Type: object
Domain: account
Event: status-change
Version: 2

|
account_id required

Title: Account ID
Description: Unique ID associated with the Pismo account.
Type: integer

new_status required

Title: New status object
Description: Object for the new account status after the status change process.
Type: object

reason_description

Title: Reason description
Description: Reason description for the change to account status.
Type: string
Min length: 1
Max length: 80
Example:
LEGAL / JUDICIAL
COMMERCIAL

reason_id

Title: Reason ID
Description: Reason ID for the change to account status.
Type: integer

reason_code

Title: Reason Code
Description: Reason code for the change to account status.
Type: string
Min length: 1
Max length: 60

reason_external_id

Title: External reason ID
Description: Customer-defined external reason ID for the change to the account status.
Type: string
Min length: 1
Max length: 60

status required

Title: New status
Description: New status for the account status change event.
Type: string
Min length: 1
Max length: 200
Example:
BLOCK
NORMAL
CANCELLATION

old_status required

Title: Old status object
Description: Object for the old account status before the status change process.
Type: object

reason_description

Title: Reason description
Description: Reason description for the change to account status.
Type: string
Min length: 1
Max length: 80
Example:
LEGAL / JUDICIAL
COMMERCIAL

reason_id

Title: Reason ID
Description: Reason ID for the change to account status.
Type: integer

reason_code

Title: Reason Code
Description: Reason code for the change to account status.
Type: string
Min length: 1
Max length: 60

reason_external_id

Title: External reason ID
Description: Customer-defined external reason ID for the change to the account status.
Type: string
Min length: 1
Max length: 60

status required

Title: Old status
Description: Old status for the account status changed event.
Type: string
Min length: 1
Max length: 200
Example:
BLOCK
NORMAL
CANCELLATION

program_id required

Title: Program ID
Description: Program ID to which the account belongs.
Type: integer

custom_fields

Title: Custom fields
Description: Metadata field with any key-value pairs.
Type: object or null
Example:
Any value

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/root.json",
    "type": "object",
    "title": "Account status changed",
    "description": "This event occurs when account status changes. \n Generated by: <a href='https://developers.pismo.io/pismo-docs/reference/patch-accounts-v2-accounts-accountid-status' target='_blank'>Update account status</a>, <a href='https://developers.pismo.io/pismo-docs/reference/patch-v2-accounts-accountid-status-rollback' target='_blank'>Roll back account status</a> \n More information: <a href='https://developers.pismo.io/pismo-docs/docs/account-status' target='_blank'>Account status</a>",
    "required": [
        "account_id",
        "new_status",
        "old_status",
        "program_id"
    ],
    "properties": {
        "account_id": {
            "title": "Account ID",
            "description": "Unique ID associated with the Pismo account.",
            "type": "integer",
            "minimum": 1,
            "maximum": 99999999999
        },
        "new_status": {
            "type": "object",
            "title": "New status object",
            "description": "Object for the new account status after the status change process.",
            "required": [
                "status"
            ],
            "properties": {
                "reason_description": {
                    "title": "Reason description",
                    "description": "Reason description for the change to account status.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80,
                    "examples": [
                        "LEGAL / JUDICIAL",
                        "COMMERCIAL"
                    ]
                },
                "reason_id": {
                    "title": "Reason ID",
                    "description": "Reason ID for the change to account status.",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 18446744073709551617
                },
                "reason_code": {
                    "title": "Reason Code",
                    "description": "Reason code for the change to account status.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 60
                },
                "reason_external_id": {
                    "title": "External reason ID",
                    "description": "Customer-defined external reason ID for the change to the account status.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 60
                },
                "status": {
                    "title": "New status",
                    "description": "New status for the account status change event.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200,
                    "examples": [
                        "BLOCK",
                        "NORMAL",
                        "CANCELLATION"
                    ]
                }
            }
        },
        "old_status": {
            "type": "object",
            "title": "Old status object",
            "description": "Object for the old account status before the status change process.",
            "required": [
                "status"
            ],
            "properties": {
                "reason_description": {
                    "title": "Reason description",
                    "description": "Reason description for the change to account status.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 80,
                    "examples": [
                        "LEGAL / JUDICIAL",
                        "COMMERCIAL"
                    ]
                },
                "reason_id": {
                    "title": "Reason ID",
                    "description": "Reason ID for the change to account status.",
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 18446744073709551617
                },
                "reason_code": {
                    "title": "Reason Code",
                    "description": "Reason code for the change to account status.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 60
                },
                "reason_external_id": {
                    "title": "External reason ID",
                    "description": "Customer-defined external reason ID for the change to the account status.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 60
                },
                "status": {
                    "title": "Old status",
                    "description": "Old status for the account status changed event.",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 200,
                    "examples": [
                        "BLOCK",
                        "NORMAL",
                        "CANCELLATION"
                    ]
                }
            }
        },
        "program_id": {
            "type": "integer",
            "title": "Program ID",
            "description": "Program ID to which the account belongs.",
            "minimum": 1,
            "maximum": 99999999999
        },
        "custom_fields": {
            "type": [
                "object",
                "null"
            ],
            "title": "Custom fields",
            "description": "Metadata field with any key-value pairs.",
            "examples": [
                "Any value"
            ]
        }
    }
}