Asset redeemed
This event occurs when the funds in an asset are withdrawn.
Type: object
Domain: assets
Event: asset_redemption
Version: 1
redemption_id required
Title: Redemption ID
Description: Unique redemption 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
asset_type required
Title: Asset type
Description: Financial instrument type
Type: string
Must be one of the following:
cdb
rdb
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
document_number required
Title: Document number
Description: Number of asset quota owner's legal document
Type: string
Example:
00000000012
external_id
Title: External ID
Description: External identifier for operation. Optional field provided by client in asset redemption operation.
Type: string
Example:
00000000013
redeemed_units required
Title: Redeemed units
Description: Number of units redeemed from asset quotas in redemption process
Type: number
Format: double
Example:
100.0
unit_value required
Title: Asset unit value
Description: Unit value redeemed
Type: number
Format: double
Example:
0.01
redeemed_amount required
Title: Redeemed amount
Description: Monetary value redeemed
Type: number
Format: double
Example:
999.0
currency required
Title: Currency
Description: ISO 4217 currency code
Type: string
Example:
986
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
redemption_date required
Title: Redemption date
Description: Date redemption occurred
Type: string
Format: date
Example:
2020-12-28
created_at required
Title: Created date
Description: Creation date of redemption on Pismo platform
Type: string
Format: date-time
Example:
2020-12-29T19:48:25
redeemed_unit_value
Title: Asset unit value received from API
Description: Unit value redeemed received from API
Type: number or null
Format: double
Example:
0.01
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Asset redeemed",
"description": "This event occurs when the funds in an asset are withdrawn.",
"required": [
"redemption_id",
"asset_id",
"asset_type",
"issuer_id",
"document_number",
"redeemed_units",
"unit_value",
"redeemed_amount",
"currency",
"redemption_date",
"created_at"
],
"properties": {
"redemption_id": {
"type": "string",
"title": "Redemption ID",
"description": "Unique redemption 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"
]
},
"asset_type": {
"type": "string",
"title": "Asset type",
"description": "Financial instrument type",
"enum": [
"cdb",
"rdb"
]
},
"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"
]
},
"document_number": {
"type": "string",
"title": "Document number",
"description": "Number of asset quota owner's legal document",
"examples": [
"00000000012"
]
},
"external_id": {
"type": "string",
"title": "External ID",
"description": "External identifier for operation. Optional field provided by client in asset redemption operation.",
"examples": [
"00000000013"
]
},
"redeemed_units": {
"type": "number",
"title": "Redeemed units",
"format": "double",
"description": "Number of units redeemed from asset quotas in redemption process",
"examples": [
100.0
]
},
"unit_value": {
"type": "number",
"title": "Asset unit value",
"format": "double",
"description": "Unit value redeemed",
"examples": [
0.01
]
},
"redeemed_amount": {
"type": "number",
"title": "Redeemed amount",
"format": "double",
"description": "Monetary value redeemed",
"examples": [
999.0
]
},
"currency": {
"type": "string",
"title": "Currency",
"description": "ISO 4217 currency code",
"examples": [
"986"
]
},
"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
]
},
"redemption_date": {
"type": "string",
"title": "Redemption date",
"format": "date",
"description": "Date redemption occurred",
"examples": [
"2020-12-28"
]
},
"created_at": {
"type": "string",
"title": "Created date",
"description": "Creation date of redemption on Pismo platform",
"format": "date-time",
"examples": [
"2020-12-29T19:48:25"
]
},
"redeemed_unit_value": {
"type": [
"number",
"null"
],
"title": "Asset unit value received from API",
"format": "double",
"description": "Unit value redeemed received from API",
"examples": [
0.01
]
}
}
}
{
"redemption_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
"asset_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
"asset_type": "cdb",
"issuer_id": "12345678",
"document_number": "00000000012",
"external_id": "00000000013",
"redeemed_units": 100.0,
"unit_value": 0.01,
"redeemed_amount": 999.0,
"currency": "986",
"deposit_number": 999999999,
"redemption_date": "2020-12-28",
"created_at": "2020-12-29T19:48:25",
"redeemed_unit_value": 0.01
}
Updated 10 days ago