Deposit product created

Type: object
Domain: deposit-product
Event: creation
Version: 1

|
product_id required

Title: Product Identifier
Description: Product identifier in the pismo platform. UUID v4 format
Type: string
Example:
2c336e9d-d04f-4fd0-8f6e-25808f48d70c

name required

Title: Product Name
Description: Name given to the product by the customer
Type: string
Example:
My product

interest_plan_id required

Title: Interest Plan Identifier
Description: Interest plan identifier in the pismo platform. UUID v4 format
Type: string
Example:
b935acaf-886c-4817-8f7c-c2cc3ce4d509

fee_model_id

Title: Fee Model Identifier
Description: Fee model identifier in the pismo platform. UUID v4 format
Type: string
Example:
b01923ae-e304-40da-a96f-87a76ef827b9

term_type required

Title: Term Type
Description: Type of deposit product term, it can be either FIXED or FLEXIBLE
Type: string
Example:
FIXED
FLEXIBLE

min_term

Title: Minimum Term
Description: Minimum term duration, in days
Type: integer
Example:
5

max_term

Title: Maximum Term
Description: Maximum term duration, in days
Type: integer
Example:
10

min_amount

Title: Minimum Amount
Description: Minimum deposit amount
Type: number
Example:
10.2
20

max_amount

Title: Maximum Amount
Description: Maximum deposit amount
Type: number
Example:
20.7
30

cool_off_period

Title: Cool Off Period
Description: Period in days during which withdrawals are allowed without penalties
Type: integer
Example:
3

funding_duration

Title: Funding Duration
Description: Period in days during which funds can be deposited into the account before operations are blocked
Type: integer
Example:
5

maturity_instructions required

Title: Maturity Instructions
Description: Instructions about how funds are processed once maturity date is reached
Type: object

initial_investment required

Title: Initial Investment
Description: How initial investment funds are processed once the maturity date is reached. This can be either PAY or ROLLOVER
Type: string
Example:
PAY
ROLLOVER

interest required

Title: Interest
Description: How interest funds are processed once the maturity date is reached. This can be either PAY or ROLLOVER
Type: string
Example:
PAY
ROLLOVER

processing_codes required

Title: Processing Codes
Description: Processing codes used for accounting
Type: object

interest_processing_code required

Title: Interest Processing Code
Description: Processing code for interest processing
Type: string
Example:
202526

maturity_processing_code required

Title: Maturity Processing Code
Description: Processing code for maturity processing
Type: string
Example:
202527

detach_processing_code required

Title: Detach Processing Code
Description: Processing code for detach processing
Type: string
Example:
202528

penalty_processing_code required

Title: Penalty Processing Code
Description: Processing code for penalty processing
Type: string
Example:
202529

withholding_tax_processing_code

Title: Withholding Tax Processing Code
Description: Processing code for withholding tax processing
Type: string
Example:
202530

status required

Title: Status
Description: Deposit product status. A new product's status is always CREATED
Type: string
Example:
CREATED

created_at required

Title: Creation Datetime
Description: Deposit product creation date time. Represented as a RFC3339 timestamp
Type: string
Example:
2024-01-23T13:26:25Z

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Deposit product created",
    "required": [
        "product_id",
        "name",
        "interest_plan_id",
        "term_type",
        "maturity_instructions",
        "processing_codes",
        "status",
        "created_at"
    ],
    "properties": {
        "product_id": {
            "type": "string",
            "title": "Product Identifier",
            "description": "Product identifier in the pismo platform. UUID v4 format",
            "examples": [
                "2c336e9d-d04f-4fd0-8f6e-25808f48d70c"
            ]
        },
        "name": {
            "type": "string",
            "title": "Product Name",
            "description": "Name given to the product by the customer",
            "examples": [
                "My product"
            ]
        },
        "interest_plan_id": {
            "type": "string",
            "title": "Interest Plan Identifier",
            "description": "Interest plan identifier in the pismo platform. UUID v4 format",
            "examples": [
                "b935acaf-886c-4817-8f7c-c2cc3ce4d509"
            ]
        },
        "fee_model_id": {
            "type": "string",
            "title": "Fee Model Identifier",
            "description": "Fee model identifier in the pismo platform. UUID v4 format",
            "examples": [
                "b01923ae-e304-40da-a96f-87a76ef827b9"
            ]
        },
        "term_type": {
            "type": "string",
            "title": "Term Type",
            "description": "Type of deposit product term, it can be either `FIXED` or `FLEXIBLE`",
            "examples": [
                "FIXED",
                "FLEXIBLE"
            ]
        },
        "min_term": {
            "type": "integer",
            "title": "Minimum Term",
            "description": "Minimum term duration, in days",
            "examples": [
                5
            ]
        },
        "max_term": {
            "type": "integer",
            "title": "Maximum Term",
            "description": "Maximum term duration, in days",
            "examples": [
                10
            ]
        },
        "min_amount": {
            "type": "number",
            "title": "Minimum Amount",
            "description": "Minimum deposit amount",
            "examples": [
                10.2,
                20
            ]
        },
        "max_amount": {
            "type": "number",
            "title": "Maximum Amount",
            "description": "Maximum deposit amount",
            "examples": [
                20.7,
                30
            ]
        },
        "cool_off_period": {
            "type": "integer",
            "title": "Cool Off Period",
            "description": "Period in days during which withdrawals are allowed without penalties",
            "examples": [
                3
            ]
        },
        "funding_duration": {
            "type": "integer",
            "title": "Funding Duration",
            "description": "Period in days during which funds can be deposited into the account before operations are blocked",
            "examples": [
                5
            ]
        },
        "maturity_instructions": {
            "$ref": "#/definitions/maturity_instructions"
        },
        "processing_codes": {
            "$ref": "#/definitions/processing_codes"
        },
        "status": {
            "type": "string",
            "title": "Status",
            "description": "Deposit product status. A new product's status is always `CREATED`",
            "examples": [
                "CREATED"
            ]
        },
        "created_at": {
            "type": "string",
            "title": "Creation Datetime",
            "description": "Deposit product creation date time. Represented as a RFC3339 timestamp",
            "examples": [
                "2024-01-23T13:26:25Z"
            ]
        }
    },
    "definitions": {
        "maturity_instructions": {
            "type": "object",
            "title": "Maturity Instructions",
            "description": "Instructions about how funds are processed once maturity date is reached",
            "properties": {
                "initial_investment": {
                    "type": "string",
                    "title": "Initial Investment",
                    "description": "How initial investment funds are processed once the maturity date is reached. This can be either `PAY` or `ROLLOVER`",
                    "examples": [
                        "PAY",
                        "ROLLOVER"
                    ]
                },
                "interest": {
                    "type": "string",
                    "title": "Interest",
                    "description": "How interest funds are processed once the maturity date is reached. This can be either `PAY` or `ROLLOVER`",
                    "examples": [
                        "PAY",
                        "ROLLOVER"
                    ]
                }
            },
            "required": [
                "initial_investment",
                "interest"
            ]
        },
        "processing_codes": {
            "type": "object",
            "title": "Processing Codes",
            "description": "Processing codes used for accounting",
            "properties": {
                "interest_processing_code": {
                    "type": "string",
                    "title": "Interest Processing Code",
                    "description": "Processing code for interest processing",
                    "examples": [
                        "202526"
                    ]
                },
                "maturity_processing_code": {
                    "type": "string",
                    "title": "Maturity Processing Code",
                    "description": "Processing code for maturity processing",
                    "examples": [
                        "202527"
                    ]
                },
                "detach_processing_code": {
                    "type": "string",
                    "title": "Detach Processing Code",
                    "description": "Processing code for detach processing",
                    "examples": [
                        "202528"
                    ]
                },
                "penalty_processing_code": {
                    "type": "string",
                    "title": "Penalty Processing Code",
                    "description": "Processing code for penalty processing",
                    "examples": [
                        "202529"
                    ]
                },
                "withholding_tax_processing_code": {
                    "type": "string",
                    "title": "Withholding Tax Processing Code",
                    "description": "Processing code for withholding tax processing",
                    "examples": [
                        "202530"
                    ]
                }
            },
            "required": [
                "interest_processing_code",
                "maturity_processing_code",
                "detach_processing_code",
                "penalty_processing_code"
            ]
        }
    }
}
{
    "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
    "name": "My product",
    "interest_plan_id": "b935acaf-886c-4817-8f7c-c2cc3ce4d509",
    "fee_model_id": "b01923ae-e304-40da-a96f-87a76ef827b9",
    "term_type": "FIXED",
    "min_term": 5,
    "max_term": 10,
    "min_amount": 10.2,
    "max_amount": 20.7,
    "cool_off_period": 3,
    "funding_duration": 5,
    "maturity_instructions": {
        "initial_investment": "PAY",
        "interest": "PAY"
    },
    "processing_codes": {
        "interest_processing_code": "202526",
        "maturity_processing_code": "202527",
        "detach_processing_code": "202528",
        "penalty_processing_code": "202529",
        "withholding_tax_processing_code": "202530"
    },
    "status": "CREATED",
    "created_at": "2024-01-23T13:26:25Z"
}