Quota updated

This event occurs when a quota is updated.

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

quota required

Title: Quota updated
Type: object

id required

Title: Quota ID
Description: Unique quota identifier defined by Pismo platform
Type: string
Example:
66989cfa-b058-40b8-b0bb-11f0b8ac94d3

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

purchased_units required

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

type required

Title: Entity type
Description: Legal nature of asset quota owner
Type: string
Example:
natural
legal

customer_name required

Title: Customer name
Description: Name of asset quota owner. Can be a company or an individual.
Type: string
Example:
Lorem ipsum

customer_document_number required

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

deposit_number

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

operation_type required

Title: Operation type
Description: The operation type determines whether the transaction impacts positively (CREDIT || Credit on Savings) or negatively (DEBIT || Debit on Savings).
Type: string

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Quota updated",
    "description": "This event occurs when a quota is updated.",
    "required": [
        "quota"
    ],
    "properties": {
        "quota": {
            "type": "object",
            "title": "Quota updated",
            "required": [
                "id",
                "asset_id",
                "issuer_id",
                "purchased_units",
                "type",
                "customer_name",
                "customer_document_number",
                "operation_type"
            ],
            "properties": {
                "id": {
                    "type": "string",
                    "title": "Quota ID",
                    "description": "Unique quota identifier defined by Pismo platform",
                    "examples": [
                        "66989cfa-b058-40b8-b0bb-11f0b8ac94d3"
                    ]
                },
                "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"
                    ]
                },
                "purchased_units": {
                    "type": "number",
                    "title": "Purchased quota units",
                    "description": "Number of quota units purchased by asset quota owner",
                    "format": "double",
                    "examples": [
                        100.0
                    ]
                },
                "type": {
                    "type": "string",
                    "title": "Entity type",
                    "description": "Legal nature of asset quota owner",
                    "examples": [
                        "natural",
                        "legal"
                    ]
                },
                "customer_name": {
                    "type": "string",
                    "title": "Customer name",
                    "description": "Name of asset quota owner. Can be a company or an individual.",
                    "examples": [
                        "Lorem ipsum"
                    ]
                },
                "customer_document_number": {
                    "type": "string",
                    "title": "Customer document number",
                    "description": "Number of asset quota owner's legal document",
                    "examples": [
                        "00000000012"
                    ]
                },
                "deposit_number": {
                    "type": [
                        "number",
                        "null"
                    ],
                    "title": "Deposit number of the asset quota",
                    "description": "Optional attribute provided by customer when registering asset quota on Pismo platform",
                    "format": "int",
                    "examples": [
                        999999999
                    ]
                },
                "operation_type": {
                    "type": "string",
                    "title": "Operation type",
                    "description": "The operation type determines whether the transaction impacts positively (CREDIT || Credit on Savings) or negatively (DEBIT || Debit on Savings)."
                }
            }
        }
    }
}

Updated 10 days ago