Interest redemption account succeeded

This event occurs when a quota is redeemed by value from account with product interest-management.

Type: object
Domain: interest-management
Event: interest_redemption_account_success
Version: 1

|
external_redemption_id required

Title: External ID
Description: External identifier for operation.
Type: string
Example:
cf1fb701-186d-426d-ac0f-331f83dfb3ce

external_account_id required

Title: External account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string
Example:
00011122200

customer_document_number required

Title: Customer document number
Description: Number of asset quota owner's legal document
Type: string
Example:
00000000012

created_at required

Title: Created date
Description: Creation date of asset on Pismo platform
Type: string
Format: date-time
Example:
2024-01-23T13:26:25

redemption_date required

Title: Redemption date
Description: Date quota was totally/partially redeemed by client
Type: string
Format: date
Example:
2024-01-22

redemption_id required

Title: Redemption ID
Description: Redemption identifier.
Type: string
Example:
e5d7523c-a804-40ef-b489-3881d63392f7

asset_type required

Title: Asset type
Description: Financial instrument type
Type: string
Must be one of the following:
cdb
rdb

assets required

Title: List of assets
Description: Asset.
Type: array

asset_id required

Title: Asset ID
Description: Unique asset identifier defined by client. This is part of the asset identifier on the Pismo platform. It can be used to make redemptions and cancellations.
Type: string
Example:
2e243c9f-2de6-4cfa-89d9-da871fdb8aab

currency_code required

Title: Currency code
Description: ISO 4217 currency code
Type: string
Example:
986

net_redeemed_amount required

Title: Net Amount Redeemed
Description: Net Value to be redeemed from quota
Type: number
Format: double
Example:
506.8

gross_redeemed_amount required

Title: Gross Amount Redeemed
Description: Gross Value to be redeemed from quota
Type: number
Format: double
Example:
508.81

redeemed_units required

Title: Redeemed quota units
Description: Number of quota units redeemed by asset quota owner
Type: number
Format: double
Example:
30000

net_unit_value required

Title: Net Unit value
Description: Gross value of the asset's units
Type: number
Format: double
Example:
0.01013896

gross_unit_value required

Title: Gross Unit value
Description: Net value of the asset's units
Type: number
Format: double
Example:
0.0101793

taxes required

Title: List of taxes
Description: Taxes to be applied to redemptions
Type: array

name required

Title: Name
Description: Name of tax
Type: string
Example:
IR
IOF

amount required

Title: Amount
Description: Amount to be considered as tax
Type: number
Format: double
Example:
3.01

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Interest redemption account succeeded",
    "description": "This event occurs when a quota is redeemed by value from account with product interest-management.",
    "required": [
        "external_redemption_id",
        "external_account_id",
        "customer_document_number",
        "created_at",
        "redemption_date",
        "redemption_id",
        "asset_type",
        "assets"
    ],
    "properties": {
        "external_redemption_id": {
            "type": "string",
            "title": "External ID",
            "description": "External identifier for operation.",
            "examples": [
                "cf1fb701-186d-426d-ac0f-331f83dfb3ce"
            ]
        },
        "external_account_id": {
            "type": "string",
            "title": "External account identifier",
            "description": "A custom account ID string that uniquely identifies the account within your organization.",
            "examples": [
                "00011122200"
            ]
        },
        "customer_document_number": {
            "type": "string",
            "title": "Customer document number",
            "description": "Number of asset quota owner's legal document",
            "examples": [
                "00000000012"
            ]
        },
        "created_at": {
            "type": "string",
            "title": "Created date",
            "description": "Creation date of asset on Pismo platform",
            "format": "date-time",
            "examples": [
                "2024-01-23T13:26:25"
            ]
        },
        "redemption_date": {
            "type": "string",
            "title": "Redemption date",
            "description": "Date quota was totally/partially redeemed by client",
            "format": "date",
            "examples": [
                "2024-01-22"
            ]
        },
        "redemption_id": {
            "type": "string",
            "title": "Redemption ID",
            "description": "Redemption identifier.",
            "examples": [
                "e5d7523c-a804-40ef-b489-3881d63392f7"
            ]
        },
        "asset_type": {
            "type": "string",
            "title": "Asset type",
            "description": "Financial instrument type",
            "enum": [
                "cdb",
                "rdb"
            ]
        },
        "assets": {
            "type": "array",
            "title": "List of assets",
            "items": {
                "$ref": "#/definitions/asset"
            }
        }
    },
    "definitions": {
        "asset": {
            "type": "object",
            "title": "Asset",
            "description": "Asset.",
            "required": [
                "asset_id",
                "currency_code",
                "net_redeemed_amount",
                "gross_redeemed_amount",
                "redeemed_units",
                "net_unit_value",
                "gross_unit_value",
                "taxes"
            ],
            "properties": {
                "asset_id": {
                    "type": "string",
                    "title": "Asset ID",
                    "description": "Unique asset identifier defined by client. This is part of the asset identifier on the Pismo platform. It can be used to make redemptions and cancellations.",
                    "examples": [
                        "2e243c9f-2de6-4cfa-89d9-da871fdb8aab"
                    ]
                },
                "currency_code": {
                    "type": "string",
                    "title": "Currency code",
                    "description": "ISO 4217 currency code",
                    "examples": [
                        "986"
                    ]
                },
                "net_redeemed_amount": {
                    "type": "number",
                    "title": "Net Amount Redeemed",
                    "description": "Net Value to be redeemed from quota",
                    "format": "double",
                    "examples": [
                        506.8
                    ]
                },
                "gross_redeemed_amount": {
                    "type": "number",
                    "title": "Gross Amount Redeemed",
                    "description": "Gross Value to be redeemed from quota",
                    "format": "double",
                    "examples": [
                        508.81
                    ]
                },
                "redeemed_units": {
                    "type": "number",
                    "title": "Redeemed quota units",
                    "description": "Number of quota units redeemed by asset quota owner",
                    "format": "double",
                    "examples": [
                        30000
                    ]
                },
                "net_unit_value": {
                    "type": "number",
                    "title": "Net Unit value",
                    "description": "Gross value of the asset's units",
                    "format": "double",
                    "examples": [
                        0.01013896
                    ]
                },
                "gross_unit_value": {
                    "type": "number",
                    "title": "Gross Unit value",
                    "description": "Net value of the asset's units",
                    "format": "double",
                    "examples": [
                        0.0101793
                    ]
                },
                "taxes": {
                    "type": "array",
                    "title": "List of taxes",
                    "items": {
                        "$ref": "#/definitions/taxes"
                    }
                }
            }
        },
        "taxes": {
            "type": "object",
            "title": "Taxes attributes",
            "required": [
                "name",
                "amount"
            ],
            "description": "Taxes to be applied to redemptions",
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Name",
                    "description": "Name of tax",
                    "examples": [
                        "IR",
                        "IOF"
                    ]
                },
                "amount": {
                    "type": "number",
                    "format": "double",
                    "title": "Amount",
                    "description": "Amount to be considered as tax",
                    "examples": [
                        3.01
                    ]
                }
            }
        }
    }
}
{
    "external_redemption_id": "cf1fb701-186d-426d-ac0f-331f83dfb3ce",
    "external_account_id": "00011122200",
    "customer_document_number": "00000000012",
    "created_at": "2024-01-23T13:26:25",
    "redemption_date": "2024-01-22",
    "redemption_id": "e5d7523c-a804-40ef-b489-3881d63392f7",
    "asset_type": "cdb",
    "assets": {
        "asset_id": "2e243c9f-2de6-4cfa-89d9-da871fdb8aab",
        "currency_code": "986",
        "net_redeemed_amount": 506.8,
        "gross_redeemed_amount": 508.81,
        "redeemed_units": 30000,
        "net_unit_value": 0.01013896,
        "gross_unit_value": 0.0101793,
        "taxes": {
            "name": "IR",
            "amount": 3.01
        }
    }
}