Asset redemption failed

This event occurs when an asset redemption fails.

Type: object
Domain: assets
Event: asset_redemption_failure
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

customer_document_number required

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

units required

Title: Units to be redeemed
Description: Number of units to be redeemed from asset quotas in redemption process
Type: number
Format: double
Example:
100.0

deposit_number

Title: Deposit number of the asset quota
Description: Optional attribute provided by client when registering asset quota on Pismo platform
Type: number or null
Format: int
Example:
999999999

external_id

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

message required

Title: Error message
Description: Description of error that occurred when trying to register new asset or quota
Type: string
Example:
This asset does not have any more available units.

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Asset redemption failed",
    "description": "This event occurs when an asset redemption fails.",
    "required": [
        "asset_id",
        "issuer_id",
        "customer_document_number",
        "units",
        "message"
    ],
    "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"
            ]
        },
        "customer_document_number": {
            "type": "string",
            "title": "Customer document number",
            "description": "Number of asset quota owner's legal document",
            "examples": [
                "00000000012"
            ]
        },
        "units": {
            "type": "number",
            "title": "Units to be redeemed",
            "format": "double",
            "description": "Number of units to be redeemed from asset quotas in redemption process",
            "examples": [
                100.0
            ]
        },
        "deposit_number": {
            "type": [
                "number",
                "null"
            ],
            "title": "Deposit number of the asset quota",
            "description": "Optional attribute provided by client when registering asset quota on Pismo platform",
            "format": "int",
            "examples": [
                999999999
            ]
        },
        "external_id": {
            "type": "string",
            "title": "External ID",
            "description": "External identifier for operation. Optional field provided by client in asset redemption operation.",
            "examples": [
                "00000000013"
            ]
        },
        "message": {
            "type": "string",
            "title": "Error message",
            "description": "Description of error that occurred when trying to register new asset or quota",
            "examples": [
                "This asset does not have any more available units."
            ]
        }
    }
}

{
    "asset_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
    "issuer_id": "12345678",
    "customer_document_number": "00000000012",
    "units": 100.0,
    "deposit_number": 999999999,
    "external_id": "00000000013",
    "message": "This asset does not have any more available units."
}

Updated 7 days ago