Interest redemption account succeeded
This event occurs when a quota is redeemed by value from account with product interest-management.
Type: object
Domain: interest-management
Event: interest_redemption_account_success
Version: 1
external_redemption_id required
Title: External ID
Description: External identifier for operation.
Type: string
Example:
cf1fb701-186d-426d-ac0f-331f83dfb3ce
external_account_id required
Title: External account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string
Example:
00011122200
customer_document_number
Title: Customer document number
Description: Number of asset quota owner's legal document
Type: string
Example:
00000000012
created_at required
Title: Created date
Description: Creation date of asset on Pismo platform
Type: string
Format: date-time
Example:
2024-01-23T13:26:25
redemption_date required
Title: Redemption date
Description: Date quota was totally/partially redeemed by client
Type: string
Format: date
Example:
2024-01-22
redemption_id required
Title: Redemption ID
Description: Redemption identifier.
Type: string
Example:
e5d7523c-a804-40ef-b489-3881d63392f7
asset_type required
Title: Asset type
Description: Financial instrument type
Type: string
Must be one of the following:
CDB
RDB
assets required
Title: List of assets
Description: Asset.
Type: arrayasset_id required
Title: Asset ID
Description: Unique asset identifier defined by Pismo.
Type: string
Example:
2e243c9f-2de6-4cfa-89d9-da871fdb8aabexternal_asset_id required
Title: External asset ID
Description: Unique asset short identifier defined by Pismo.
Type: string or null
Example:
kxBHNMCAYDnQavcurrency_code required
Title: Currency code
Description: ISO 4217 currency code
Type: string
Example:
986net_redeemed_amount required
Title: Net Amount Redeemed
Description: Net Value to be redeemed from quota
Type: number
Format: double
Example:
506.8gross_redeemed_amount required
Title: Gross Amount Redeemed
Description: Gross Value to be redeemed from quota
Type: number
Format: double
Example:
508.81redeemed_units required
Title: Redeemed quota units
Description: Number of quota units redeemed by asset quota owner
Type: number
Format: double
Example:
30000net_unit_value required
Title: Net Unit value
Description: Gross value of the asset's units
Type: number
Format: double
Example:
0.01013896gross_unit_value required
Title: Gross Unit value
Description: Net value of the asset's units
Type: number
Format: double
Example:
0.0101793taxes required
Title: List of taxes
Description: Taxes to be applied to redemptions
Type: arrayname required
Title: Tax Name
Description: Tax Name.
Type: string
Example:
IR
IOFamount required
Title: Tax Amount
Description: Tax Amount.
Type: number
Format: double
Example:
0.15rate required
Title: Tax Rate
Description: Tax Rate.
Type: number
Format: double
Example:
22.5remaining_amount required
Title: Remaining quota attributes
Description: Remaining quota available for redemption
Type: objectgross_amount required
Title: Remaining Gross Amount
Description: Remaining Gross Amount from quota
Type: number
Format: double
Example:
100.0net_amount required
Title: Remaining Net Amount
Description: Remaining Net Amount from quota
Type: number
Format: double
Example:
100.0taxes required
Title: List of taxes of remaining quota
Description: Taxes to be applied to redemptions of remaining quota
Type: arrayname required
Title: Tax Name
Description: Tax Name.
Type: string
Example:
IR
IOFamount required
Title: Tax Amount
Description: Tax Amount.
Type: number
Format: double
Example:
100.0
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Interest redemption account succeeded",
"description": "This event occurs when a quota is redeemed by value from account with product interest-management.",
"required": [
"external_redemption_id",
"external_account_id",
"created_at",
"redemption_date",
"redemption_id",
"asset_type",
"assets"
],
"properties": {
"external_redemption_id": {
"type": "string",
"title": "External ID",
"description": "External identifier for operation.",
"examples": [
"cf1fb701-186d-426d-ac0f-331f83dfb3ce"
]
},
"external_account_id": {
"type": "string",
"title": "External account identifier",
"description": "A custom account ID string that uniquely identifies the account within your organization.",
"examples": [
"00011122200"
]
},
"customer_document_number": {
"type": "string",
"title": "Customer document number",
"description": "Number of asset quota owner's legal document",
"examples": [
"00000000012"
]
},
"created_at": {
"type": "string",
"title": "Created date",
"description": "Creation date of asset on Pismo platform",
"format": "date-time",
"examples": [
"2024-01-23T13:26:25"
]
},
"redemption_date": {
"type": "string",
"title": "Redemption date",
"description": "Date quota was totally/partially redeemed by client",
"format": "date",
"examples": [
"2024-01-22"
]
},
"redemption_id": {
"type": "string",
"title": "Redemption ID",
"description": "Redemption identifier.",
"examples": [
"e5d7523c-a804-40ef-b489-3881d63392f7"
]
},
"asset_type": {
"type": "string",
"title": "Asset type",
"description": "Financial instrument type",
"enum": [
"CDB",
"RDB"
]
},
"assets": {
"type": "array",
"title": "List of assets",
"items": {
"$ref": "#/definitions/asset"
}
}
},
"definitions": {
"asset": {
"type": "object",
"title": "Asset",
"description": "Asset.",
"required": [
"asset_id",
"external_asset_id",
"currency_code",
"net_redeemed_amount",
"gross_redeemed_amount",
"redeemed_units",
"net_unit_value",
"gross_unit_value",
"taxes",
"remaining_amount"
],
"properties": {
"asset_id": {
"type": "string",
"title": "Asset ID",
"description": "Unique asset identifier defined by Pismo.",
"examples": [
"2e243c9f-2de6-4cfa-89d9-da871fdb8aab"
]
},
"external_asset_id": {
"type": [
"string",
"null"
],
"title": "External asset ID",
"description": "Unique asset short identifier defined by Pismo.",
"examples": [
"kxBHNMCAYDnQav"
]
},
"currency_code": {
"type": "string",
"title": "Currency code",
"description": "ISO 4217 currency code",
"examples": [
"986"
]
},
"net_redeemed_amount": {
"type": "number",
"title": "Net Amount Redeemed",
"description": "Net Value to be redeemed from quota",
"format": "double",
"examples": [
506.8
]
},
"gross_redeemed_amount": {
"type": "number",
"title": "Gross Amount Redeemed",
"description": "Gross Value to be redeemed from quota",
"format": "double",
"examples": [
508.81
]
},
"redeemed_units": {
"type": "number",
"title": "Redeemed quota units",
"description": "Number of quota units redeemed by asset quota owner",
"format": "double",
"examples": [
30000
]
},
"net_unit_value": {
"type": "number",
"title": "Net Unit value",
"description": "Gross value of the asset's units",
"format": "double",
"examples": [
0.01013896
]
},
"gross_unit_value": {
"type": "number",
"title": "Gross Unit value",
"description": "Net value of the asset's units",
"format": "double",
"examples": [
0.0101793
]
},
"taxes": {
"type": "array",
"title": "List of taxes",
"items": {
"$ref": "#/definitions/taxes"
}
},
"remaining_amount": {
"type": "object",
"title": "Remaining quota attributes",
"required": [
"gross_amount",
"net_amount",
"taxes"
],
"description": "Remaining quota available for redemption",
"properties": {
"gross_amount": {
"type": "number",
"title": "Remaining Gross Amount",
"description": "Remaining Gross Amount from quota",
"format": "double",
"examples": [
100.0
]
},
"net_amount": {
"type": "number",
"title": "Remaining Net Amount",
"description": "Remaining Net Amount from quota",
"format": "double",
"examples": [
100.0
]
},
"taxes": {
"type": "array",
"title": "List of taxes of remaining quota",
"items": {
"$ref": "#/definitions/remaining_taxes"
}
}
}
}
}
},
"taxes": {
"type": "object",
"title": "Taxes attributes",
"required": [
"name",
"amount",
"rate"
],
"description": "Taxes to be applied to redemptions",
"properties": {
"name": {
"type": "string",
"title": "Tax Name",
"description": "Tax Name.",
"examples": [
"IR",
"IOF"
]
},
"amount": {
"type": "number",
"title": "Tax Amount",
"description": "Tax Amount.",
"format": "double",
"examples": [
0.15
]
},
"rate": {
"type": "number",
"title": "Tax Rate",
"description": "Tax Rate.",
"format": "double",
"examples": [
22.5
]
}
}
},
"remaining_taxes": {
"type": "object",
"title": "Remaining Taxes attributes",
"required": [
"name",
"amount"
],
"description": "Taxes to be applied to redemptions of remaining quota",
"properties": {
"name": {
"type": "string",
"title": "Tax Name",
"description": "Tax Name.",
"examples": [
"IR",
"IOF"
]
},
"amount": {
"type": "number",
"title": "Tax Amount",
"description": "Tax Amount.",
"format": "double",
"examples": [
100.0
]
}
}
}
}
}
{
"external_redemption_id": "cf1fb701-186d-426d-ac0f-331f83dfb3ce",
"external_account_id": "00011122200",
"customer_document_number": "00000000012",
"created_at": "2024-01-23T13:26:25",
"redemption_date": "2024-01-22",
"redemption_id": "e5d7523c-a804-40ef-b489-3881d63392f7",
"asset_type": "CDB",
"assets": {
"asset_id": "2e243c9f-2de6-4cfa-89d9-da871fdb8aab",
"external_asset_id": "kxBHNMCAYDnQav",
"currency_code": "986",
"net_redeemed_amount": 506.8,
"gross_redeemed_amount": 508.81,
"redeemed_units": 30000,
"net_unit_value": 0.01013896,
"gross_unit_value": 0.0101793,
"taxes": {
"name": "IR",
"amount": 0.15,
"rate": 22.5
},
"remaining_amount": {
"gross_amount": 100.0,
"net_amount": 100.0,
"taxes": {
"name": "IR",
"amount": 100.0
}
}
}
}
Updated 4 days ago