Asset blocked

This event occurs when an asset is blocked.

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

asset_block_id required

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

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: Whether asset is blocked or unblocked
Type: string
Must be one of the following:
BLOCK
UNBLOCK

reason

Title: Reason
Description: Reason asset was blocked or unblocked.
Type: string
Example:
Court block

external_id

Title: External ID
Description: External identifier for operation. Optional field provided by customer in asset block operation.
Type: string
Example:
00000000013

units required

Title: Units
Description: Number of units blocked or unblocked
Type: number
Format: double
Example:
100.0

created_at required

Title: Created date
Description: Creation date of asset block operation on Pismo platform
Type: string
Format: date-time
Example:
2020-02-02T17:12:40Z

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Asset blocked",
    "description": "This event occurs when an asset is blocked.",
    "required": [
        "asset_block_id",
        "asset_id",
        "issuer_id",
        "status",
        "units",
        "created_at"
    ],
    "properties": {
        "asset_block_id": {
            "type": "string",
            "title": "Asset block ID",
            "description": "Unique asset block identifier. Generated by Pismo platform.",
            "examples": [
                "d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
            ]
        },
        "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": "Whether asset is blocked or unblocked",
            "enum": [
                "BLOCK",
                "UNBLOCK"
            ]
        },
        "reason": {
            "type": "string",
            "title": "Reason",
            "description": "Reason asset was blocked or unblocked.",
            "examples": [
                "Court block"
            ]
        },
        "external_id": {
            "type": "string",
            "title": "External ID",
            "description": "External identifier for operation. Optional field provided by customer in asset block operation.",
            "examples": [
                "00000000013"
            ]
        },
        "units": {
            "type": "number",
            "title": "Units",
            "format": "double",
            "description": "Number of units blocked or unblocked",
            "examples": [
                100.0
            ]
        },
        "created_at": {
            "type": "string",
            "title": "Created date",
            "description": "Creation date of asset block operation on Pismo platform",
            "format": "date-time",
            "examples": [
                "2020-02-02T17:12:40Z"
            ]
        }
    }
}

{
    "asset_block_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
    "asset_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
    "issuer_id": "12345678",
    "status": "BLOCK",
    "reason": "Court block",
    "external_id": "00000000013",
    "units": 100.0,
    "created_at": "2020-02-02T17:12:40Z"
}

Updated 3 days ago