Deposit product created

Create an organization's time deposit accounts. The Create deposit product endpoint generates this event.

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

created_at required

Title: Creation datetime
Description: Deposit product creation datetime. Represented as an RFC3339 timestamp.
Type: string
Example:
2024-01-23T13:26:25Z

interest_plan_id required

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

maturity_instructions required

Title: Maturity instructions
Description: Instructions for what to do with funds 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

name required

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

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

product_id required

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

status required

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

term_type required

Title: Term type
Description: Type of deposit product term. Can be FIXED or FLEXIBLE.
Type: string
Example:
FIXED
FLEXIBLE

cool_off_period

Title: Cool off period
Description: Period to withdraw without a fine being applied, in days.
Type: integer
Example:
3

fee_model_id

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

funding_duration

Title: Funding duration
Description: Period to deposit funds into the account before operations are blocked, in days.
Type: integer
Example:
5

max_amount

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

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

min_term

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

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Deposit product created",
    "description": "Create an organization's time deposit accounts. The <a href='https://developers.pismo.io/pismo-docs/reference/interest-bearing-v1-create-deposit-product' target='_blank'>Create deposit product</a> endpoint generates this event.",
    "required": [
        "product_id",
        "name",
        "interest_plan_id",
        "term_type",
        "maturity_instructions",
        "processing_codes",
        "status",
        "created_at"
    ],
    "properties": {
        "created_at": {
            "type": "string",
            "title": "Creation datetime",
            "description": "Deposit product creation datetime. Represented as an RFC3339 timestamp.",
            "examples": [
                "2024-01-23T13:26:25Z"
            ]
        },
        "interest_plan_id": {
            "type": "string",
            "title": "Interest plan ID",
            "description": "Interest plan ID in the pismo platform. UUID v4 format.",
            "examples": [
                "b935acaf-886c-4817-8f7c-c2cc3ce4d509"
            ]
        },
        "maturity_instructions": {
            "$ref": "#/definitions/maturity_instructions"
        },
        "name": {
            "type": "string",
            "title": "Product name",
            "description": "Name given to the product by the customer.",
            "examples": [
                "My product"
            ]
        },
        "processing_codes": {
            "$ref": "#/definitions/processing_codes"
        },
        "product_id": {
            "type": "string",
            "title": "Product ID",
            "description": "Product ID in the pismo platform. UUID v4 format.",
            "examples": [
                "2c336e9d-d04f-4fd0-8f6e-25808f48d70c"
            ]
        },
        "status": {
            "type": "string",
            "title": "Status",
            "description": "Deposit product status. A new product's status is always \"CREATED\".",
            "examples": [
                "CREATED"
            ]
        },
        "term_type": {
            "type": "string",
            "title": "Term type",
            "description": "Type of deposit product term. Can be `FIXED` or `FLEXIBLE`.",
            "examples": [
                "FIXED",
                "FLEXIBLE"
            ]
        },
        "cool_off_period": {
            "type": "integer",
            "title": "Cool off period",
            "description": "Period to withdraw without a fine being applied, in days.",
            "examples": [
                3
            ]
        },
        "fee_model_id": {
            "type": "string",
            "title": "Fee model ID",
            "description": "Fee model ID in the pismo platform. UUID v4 format.",
            "examples": [
                "b01923ae-e304-40da-a96f-87a76ef827b9"
            ]
        },
        "funding_duration": {
            "type": "integer",
            "title": "Funding duration",
            "description": "Period to deposit funds into the account before operations are blocked, in days.",
            "examples": [
                5
            ]
        },
        "max_amount": {
            "type": "number",
            "title": "Maximum amount",
            "description": "Maximum deposit amount.",
            "examples": [
                20.7,
                30
            ]
        },
        "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
            ]
        },
        "min_term": {
            "type": "integer",
            "title": "Minimum term",
            "description": "Minimum term duration, in days.",
            "examples": [
                5
            ]
        }
    },
    "definitions": {
        "maturity_instructions": {
            "type": "object",
            "title": "Maturity instructions",
            "description": "Instructions for what to do with funds 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"
            ]
        }
    }
}

{
    "created_at": "2024-01-23T13:26:25Z",
    "interest_plan_id": "b935acaf-886c-4817-8f7c-c2cc3ce4d509",
    "maturity_instructions": {
        "initial_investment": "PAY",
        "interest": "PAY"
    },
    "name": "My product",
    "processing_codes": {
        "interest_processing_code": "202526",
        "maturity_processing_code": "202527",
        "detach_processing_code": "202528",
        "penalty_processing_code": "202529",
        "withholding_tax_processing_code": "202530"
    },
    "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
    "status": "CREATED",
    "term_type": "FIXED",
    "cool_off_period": 3,
    "fee_model_id": "b01923ae-e304-40da-a96f-87a76ef827b9",
    "funding_duration": 5,
    "max_amount": 20.7,
    "max_term": 10,
    "min_amount": 10.2,
    "min_term": 5
}