Events
About PismoContact Us

Interest redemption succeeded

This event occurs when a quota is redeemed with product interest-management.

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

|
external_redemption_id required

Title: External ID
Description: External identifier for operation.
Type: string
Example:
deposit:6104253a-qt53-41m0-a630-2z1h2761e3f8

external_account_id required

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

customer_document_number

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:
2020-12-29T19:48:25

redemption_date required

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

asset_id required

Title: Asset ID
Description: Unique asset identifier defined by Pismo.
Type: string
Example:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3

external_asset_id required

Title: External asset ID
Description: Unique asset short identifier defined by Pismo.
Type: string or null
Example:
kxBHNMCAYDnQav

redemption_id required

Title: Redemption ID
Description: Redemption identifier.
Type: string
Example:
redemption:6104253b-qt53-41m0-a630-2z1h2761e3f8

asset_type required

Title: Asset type
Description: Financial instrument type
Type: string
Must be one of the following:
CDB
RDB

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:
100.0

gross_redeemed_amount required

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

redeemed_units required

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

net_unit_value required

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

gross_unit_value required

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

taxes required

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

name required

Title: Tax Name
Description: Tax Name.
Type: string
Example:
IR
IOF

amount required

Title: Tax Amount
Description: Tax Amount.
Type: number
Format: double
Example:
0.15

rate required

Title: Tax Rate
Description: Tax Rate.
Type: number
Format: double
Example:
22.5

remaining_amount required

Title: Remaining quota attributes
Description: Remaining quota available for redemption
Type: object

gross_amount required

Title: Remaining Gross Amount
Description: Remaining Gross Amount from quota
Type: number
Format: double
Example:
100.0

net_amount required

Title: Remaining Net Amount
Description: Remaining Net Amount from quota
Type: number
Format: double
Example:
100.0

taxes required

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

name required

Title: Tax Name
Description: Tax Name.
Type: string
Example:
IR
IOF

amount required

Title: Tax Amount
Description: Tax Amount.
Type: number
Format: double
Example:
100.0

 
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Interest redemption succeeded",
    "description": "This event occurs when a quota is redeemed with product interest-management.",
    "required": [
        "external_redemption_id",
        "external_account_id",
        "created_at",
        "redemption_date",
        "asset_id",
        "external_asset_id",
        "redemption_id",
        "asset_type",
        "currency_code",
        "net_redeemed_amount",
        "gross_redeemed_amount",
        "redeemed_units",
        "net_unit_value",
        "gross_unit_value",
        "taxes",
        "remaining_amount"
    ],
    "properties": {
        "external_redemption_id": {
            "type": "string",
            "title": "External ID",
            "description": "External identifier for operation.",
            "examples": [
                "deposit:6104253a-qt53-41m0-a630-2z1h2761e3f8"
            ]
        },
        "external_account_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "External account identifier",
            "description": "A custom account ID string that uniquely identifies the account within your organization.",
            "examples": [
                "999999999"
            ]
        },
        "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": [
                "2020-12-29T19:48:25"
            ]
        },
        "redemption_date": {
            "type": "string",
            "title": "Redemption date",
            "description": "Date quota was totally/partially redeemed by client",
            "format": "date",
            "examples": [
                "2020-12-01"
            ]
        },
        "asset_id": {
            "type": "string",
            "title": "Asset ID",
            "description": "Unique asset identifier defined by Pismo.",
            "examples": [
                "d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
            ]
        },
        "external_asset_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "External asset ID",
            "description": "Unique asset short identifier defined by Pismo.",
            "examples": [
                "kxBHNMCAYDnQav"
            ]
        },
        "redemption_id": {
            "type": "string",
            "title": "Redemption ID",
            "description": "Redemption identifier.",
            "examples": [
                "redemption:6104253b-qt53-41m0-a630-2z1h2761e3f8"
            ]
        },
        "asset_type": {
            "type": "string",
            "title": "Asset type",
            "description": "Financial instrument type",
            "enum": [
                "CDB",
                "RDB"
            ]
        },
        "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": [
                100.0
            ]
        },
        "gross_redeemed_amount": {
            "type": "number",
            "title": "Gross Amount Redeemed",
            "description": "Gross Value to be redeemed from quota",
            "format": "double",
            "examples": [
                100.0
            ]
        },
        "redeemed_units": {
            "type": "number",
            "title": "Redeemed quota units",
            "description": "Number of quota units redeemed by asset quota owner",
            "format": "double",
            "examples": [
                100.0
            ]
        },
        "net_unit_value": {
            "type": "number",
            "title": "Net Unit value",
            "description": "Gross value of the asset's units",
            "format": "double",
            "examples": [
                1.0
            ]
        },
        "gross_unit_value": {
            "type": "number",
            "title": "Gross Unit value",
            "description": "Net value of the asset's units",
            "format": "double",
            "examples": [
                1.0
            ]
        },
        "taxes": {
            "type": "array",
            "title": "List of taxes",
            "items": {
                "$ref": "#/definitions/taxes"
            }
        },
        "remaining_amount": {
            "type": "object",
            "title": "Remaining quota attributes",
            "required": [
                "gross_amount",
                "net_amount",
                "taxes"
            ],
            "description": "Remaining quota available for redemption",
            "properties": {
                "gross_amount": {
                    "type": "number",
                    "title": "Remaining Gross Amount",
                    "description": "Remaining Gross Amount from quota",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "net_amount": {
                    "type": "number",
                    "title": "Remaining Net Amount",
                    "description": "Remaining Net Amount from quota",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "taxes": {
                    "type": "array",
                    "title": "List of taxes of remaining quota",
                    "items": {
                        "$ref": "#/definitions/remaining_taxes"
                    }
                }
            }
        }
    },
    "definitions": {
        "taxes": {
            "type": "object",
            "title": "Taxes attributes",
            "required": [
                "name",
                "amount",
                "rate"
            ],
            "description": "Taxes to be applied to redemptions",
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Tax Name",
                    "description": "Tax Name.",
                    "examples": [
                        "IR",
                        "IOF"
                    ]
                },
                "amount": {
                    "type": "number",
                    "title": "Tax Amount",
                    "description": "Tax Amount.",
                    "format": "double",
                    "examples": [
                        0.15
                    ]
                },
                "rate": {
                    "type": "number",
                    "title": "Tax Rate",
                    "description": "Tax Rate.",
                    "format": "double",
                    "examples": [
                        22.5
                    ]
                }
            }
        },
        "remaining_taxes": {
            "type": "object",
            "title": "Remaining Taxes attributes",
            "required": [
                "name",
                "amount"
            ],
            "description": "Taxes to be applied to redemptions of remaining quota",
            "properties": {
                "name": {
                    "type": "string",
                    "title": "Tax Name",
                    "description": "Tax Name.",
                    "examples": [
                        "IR",
                        "IOF"
                    ]
                },
                "amount": {
                    "type": "number",
                    "title": "Tax Amount",
                    "description": "Tax Amount.",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                }
            }
        }
    }
}

{
    "external_redemption_id": "deposit:6104253a-qt53-41m0-a630-2z1h2761e3f8",
    "external_account_id": "999999999",
    "customer_document_number": "00000000012",
    "created_at": "2020-12-29T19:48:25",
    "redemption_date": "2020-12-01",
    "asset_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
    "external_asset_id": "kxBHNMCAYDnQav",
    "redemption_id": "redemption:6104253b-qt53-41m0-a630-2z1h2761e3f8",
    "asset_type": "CDB",
    "currency_code": "986",
    "net_redeemed_amount": 100.0,
    "gross_redeemed_amount": 100.0,
    "redeemed_units": 100.0,
    "net_unit_value": 1.0,
    "gross_unit_value": 1.0,
    "taxes": {
        "name": "IR",
        "amount": 0.15,
        "rate": 22.5
    },
    "remaining_amount": {
        "gross_amount": 100.0,
        "net_amount": 100.0,
        "taxes": {
            "name": "IR",
            "amount": 100.0
        }
    }
}

Updated 4 days ago