Program attached

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

program_id required

Title: Program Identifier
Description: Program identifier in the pismo platform.
Type: integer
Example:
123456

maturity_date_days required

Title: Maturity days
Description: Number of days when maturity date is reached.
Type: integer
Example:
1111

attach_datetime required

Title: Attach Date
Description: The date and time when the program was attached.
Type: string
Format: date-time
Example:
2023-10-01T12:00:00Z

metadata

Title: Custom fields
Description: This field is used to propagate information not directly related to the transactional flow. It's in the key-value pair format and is not handled by Pismo
Type: object or null
Example:
{
    "custom_info": "value"
}

deposit required

Title: Deposit product
Description: Deposit product information
Type: object

product_id required

Title: Product Identifier
Description: Pismo product identifier in 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: Pismo interest plan identifier in UUID v4 format
Type: string
Example:
b935acaf-886c-4817-8f7c-c2cc3ce4d509

term_type required

Title: Term Type
Description: Type of deposit product term, it can be either FIXED or FLEXIBLE
Type: string
Must be one of the following:
FIXED
FLEXIBLE
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 are allowed to be deposited into the account before operations are blocked
Type: integer
Example:
5

maturity_instructions required

Title: Maturity Instructions
Description: Instructions on 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. It can be either PAY or ROLLOVER
Type: string
Must be one of the following:
PAY
ROLLOVER
Example:
PAY
ROLLOVER

interest required

Title: Interest
Description: How initial investment funds are processed once the maturity date is reached. It can be either PAY or ROLLOVER
Type: string
Must be one of the following:
PAY
ROLLOVER
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.
Type: string
Example:
ACTIVE

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": "Program attached",
    "required": [
        "program_id",
        "maturity_date_days",
        "deposit",
        "attach_datetime"
    ],
    "properties": {
        "program_id": {
            "type": "integer",
            "title": "Program Identifier",
            "description": "Program identifier in the pismo platform.",
            "examples": [
                123456
            ]
        },
        "maturity_date_days": {
            "type": "integer",
            "title": "Maturity days",
            "description": "Number of days when maturity date is reached.",
            "examples": [
                1111
            ]
        },
        "attach_datetime": {
            "type": "string",
            "format": "date-time",
            "title": "Attach Date",
            "description": "The date and time when the program was attached.",
            "examples": [
                "2023-10-01T12:00:00Z"
            ]
        },
        "metadata": {
            "type": [
                "object",
                "null"
            ],
            "title": "Custom fields",
            "description": "This field is used to propagate information not directly related to the transactional flow. It's in the key-value pair format and is not handled by Pismo",
            "examples": [
                {
                    "custom_info": "value"
                }
            ]
        },
        "deposit": {
            "$ref": "#/definitions/deposit"
        }
    },
    "definitions": {
        "maturity_instructions": {
            "type": "object",
            "title": "Maturity Instructions",
            "description": "Instructions on 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. It can be either `PAY` or `ROLLOVER`",
                    "enum": [
                        "PAY",
                        "ROLLOVER"
                    ],
                    "examples": [
                        "PAY",
                        "ROLLOVER"
                    ]
                },
                "interest": {
                    "type": "string",
                    "title": "Interest",
                    "description": "How initial investment funds are processed once the maturity date is reached. It can be either `PAY` or `ROLLOVER`",
                    "enum": [
                        "PAY",
                        "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"
            ]
        },
        "deposit": {
            "type": "object",
            "title": "Deposit product",
            "description": "Deposit product information",
            "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": "Pismo product identifier in 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": "Pismo interest plan identifier in UUID v4 format",
                    "examples": [
                        "b935acaf-886c-4817-8f7c-c2cc3ce4d509"
                    ]
                },
                "term_type": {
                    "type": "string",
                    "title": "Term Type",
                    "description": "Type of deposit product term, it can be either `FIXED` or `FLEXIBLE`",
                    "enum": [
                        "FIXED",
                        "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 are allowed to 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.",
                    "examples": [
                        "ACTIVE"
                    ]
                },
                "created_at": {
                    "type": "string",
                    "title": "Creation Datetime",
                    "description": "Deposit product creation date time. Represented as a RFC3339 timestamp",
                    "examples": [
                        "2024-01-23T13:26:25Z"
                    ]
                }
            }
        }
    }
}

{
    "program_id": 123456,
    "maturity_date_days": 1111,
    "attach_datetime": "2023-10-01T12:00:00Z",
    "metadata": {
        "custom_info": "value"
    },
    "deposit": {
        "product_id": "2c336e9d-d04f-4fd0-8f6e-25808f48d70c",
        "name": "My product",
        "interest_plan_id": "b935acaf-886c-4817-8f7c-c2cc3ce4d509",
        "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": "ACTIVE",
        "created_at": "2024-01-23T13:26:25Z"
    }
}