Asset completed event success

This event occurs when an asset is completed.

Type: object
Domain: assets
Event: asset_completed_event_success
Version: 1

|
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:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3

issuer_id required

Title: Issuer id
Description: Cetip code of registrator of asset. This is part of the asset identifier on the Pismo platform. It needs to be in every API call. An organization can have multiple issuer IDs.
Type: string
Example:
12345678

status required

Title: Asset status
Description: Status of asset
Type: string
Must be one of the following:
COMPLETED

updated_at required

Title: Updated date
Description: Date asset was last updated
Type: string
Format: date-time
Example:
2020-12-29T19:48:25

issuing_date

Title: Issuing date
Description: Date asset was effectively issued by client
Type: string
Format: date
Example:
2020-12-01

maturity_date

Title: Issuing date
Description: Date asset expires, finishing its cycle
Type: string
Format: date
Example:
2022-12-01

units

Title: Issued units
Description: Number of units asset can support. When registration_mode is single, this number should reflect the entire quota. When registration_mode is many, it should reflect the number of units available for purchase in the asset.
Type: number
Format: double
Example:
100.0

unit_value

Title: Unit value
Description: Current unit value of asset
Type: number
Format: double
Example:
3.12e-05

current_amount

Title: Current amount
Description: Current value of asset
Type: number
Format: double
Example:
3.12e-05

operation_code

Title: Operation code
Description: Optional attribute generated when asset change to completed
Type: string or null
Example:
202404110000000900

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Asset completed event success",
    "description": "This event occurs when an asset is completed.",
    "required": [
        "asset_id",
        "issuer_id",
        "status",
        "updated_at"
    ],
    "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": [
                "d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
            ]
        },
        "issuer_id": {
            "type": "string",
            "title": "Issuer id",
            "description": "Cetip code of registrator of asset. This is part of the asset identifier on the Pismo platform. It needs to be in every API call. An organization can have multiple issuer IDs.",
            "examples": [
                "12345678"
            ]
        },
        "status": {
            "type": "string",
            "title": "Asset status",
            "description": "Status of asset",
            "enum": [
                "COMPLETED"
            ]
        },
        "updated_at": {
            "type": "string",
            "title": "Updated date",
            "description": "Date asset was last updated",
            "format": "date-time",
            "examples": [
                "2020-12-29T19:48:25"
            ]
        },
        "issuing_date": {
            "type": "string",
            "title": "Issuing date",
            "description": "Date asset was effectively issued by client",
            "format": "date",
            "examples": [
                "2020-12-01"
            ]
        },
        "maturity_date": {
            "type": "string",
            "title": "Issuing date",
            "description": "Date asset expires, finishing its cycle",
            "format": "date",
            "examples": [
                "2022-12-01"
            ]
        },
        "units": {
            "type": "number",
            "title": "Issued units",
            "description": "Number of units asset can support. When `registration_mode` is `single`, this number should reflect the entire quota. When `registration_mode` is `many`, it should reflect the number of units available for purchase in the asset.",
            "format": "double",
            "examples": [
                100.0
            ]
        },
        "unit_value": {
            "type": "number",
            "title": "Unit value",
            "description": "Current unit value of asset",
            "format": "double",
            "examples": [
                3.12e-05
            ]
        },
        "current_amount": {
            "type": "number",
            "title": "Current amount",
            "description": "Current value of asset",
            "format": "double",
            "examples": [
                3.12e-05
            ]
        },
        "operation_code": {
            "type": [
                "string",
                "null"
            ],
            "title": "Operation code",
            "description": "Optional attribute generated when asset change to completed",
            "examples": [
                "202404110000000900"
            ]
        }
    }
}
{
    "asset_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
    "issuer_id": "12345678",
    "status": "COMPLETED",
    "updated_at": "2020-12-29T19:48:25",
    "issuing_date": "2020-12-01",
    "maturity_date": "2022-12-01",
    "units": 100.0,
    "unit_value": 3.12e-05,
    "current_amount": 3.12e-05,
    "operation_code": "202404110000000900"
}