Interest registration succeeded
This event occurs when an asset is registered with product interest-management.
Type: object
Domain: interest-management
Event: interest_registration_success
Version: 1
asset required
Title: Object representing the registered asset.
Type: objectasset_id required
Title: Asset ID
Description: Unique asset identifier defined by Pismo.
Type: string
Example:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3external_asset_id required
Title: External asset ID
Description: Unique asset short identifier defined by Pismo.
Type: string or null
Example:
kxBHNMCAYDnQavprogram_id required
Title: Program identification
Description: Program ID to which the account belongs within your organization.
Type: string
Example:
12345678asset_type required
Title: Asset type
Description: Financial instrument type
Type: string
Must be one of the following:
cdb
rdbregistration_mode required
Title: Registration mode
Description: Registration mode of asset
Type: string
Example:
investments
savingsissuing_date required
Title: Issuing date
Description: Date asset was effectively issued by client
Type: string
Format: date
Example:
2020-12-01maturity_date required
Title: Issuing date
Description: Date asset expires, finishingissued_unitscycle
Type: string
Format: date
Example:
2022-12-01unit_value required
Title: Unit value
Description: Value of the asset's units
Type: number
Format: double
Example:
1.0index_type required
Title: Index type
Description: Daily accrual calculations are be based on the index type. For example, "di" for DI rate or "pre" for prefixed rate.
Type: string
Must be one of the following:
di
preindex_rate
Title: Index rate
Description: How much the asset accrues per day
Type: number
Format: double
Example:
1.0interest_rate
Title: Interest rate
Description: How much the asset accrues per day
Type: number
Format: double
Example:
1.0currency_code required
Title: Currency code
Description: ISO 4217 currency code
Type: string
Example:
986early_redemption_attributes required
Title: List of early redemption attributes
Description: Custom redemption conditions
Type: arraydate required
Title: Date
Description: Custom date to be considered
Type: string
Format: date
Example:
2021-02-01interest_rate
Title: Interest rate
Description: Interest rate to be considered until date established
Type: number
Format: double
Example:
1.09floating_rate
Title: Floating rate
Description: Floating rate to be considered until date established
Type: number
Format: double
Example:
1.18has_redemption_condition
Title: Has Redemption Condition
Description: Asset identifier with different types of redemption conditions
Type: string
Example:
YES
NO
MARKET
quota required
Title: Quota registered
Type: objectcustomer_name
Title: Customer name
Description: Name of asset quota owner. Can be a company or an individual.
Type: string
Example:
Lorem ipsumcustomer_document_number
Title: Customer document number
Description: Number of asset quota owner's legal document
Type: string
Example:
00000000012customer_type
Title: Entity type
Description: Legal nature of asset quota owner
Type: string
Must be one of the following:
natural
legalissued_units required
Title: Purchased quota units
Description: Number of quota units purchased by asset quota owner
Type: number
Format: double
Example:
100.0external_account_id required
Title: External account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string or null
Example:
999999999external_quota_id required
Title: External ID
Description: External identifier for operation.
Type: string
Example:
deposit:6104253a-qt53-41m0-a630-2z1h2761e3f8
created_at required
Title: Created date
Description: Creation date of asset on Pismo platform
Type: string
Format: date-time
Example:
2020-12-29T19:48:25
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Interest registration succeeded",
"description": "This event occurs when an asset is registered with product interest-management.",
"required": [
"asset",
"quota",
"created_at"
],
"properties": {
"asset": {
"type": "object",
"title": "Object representing the registered asset.",
"required": [
"asset_id",
"external_asset_id",
"program_id",
"asset_type",
"registration_mode",
"issuing_date",
"maturity_date",
"unit_value",
"index_type",
"currency_code",
"early_redemption_attributes"
],
"properties": {
"asset_id": {
"type": "string",
"title": "Asset ID",
"description": "Unique asset identifier defined by Pismo.",
"examples": [
"d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
]
},
"external_asset_id": {
"type": [
"string",
"null"
],
"title": "External asset ID",
"description": "Unique asset short identifier defined by Pismo.",
"examples": [
"kxBHNMCAYDnQav"
]
},
"program_id": {
"type": "string",
"title": "Program identification",
"description": "Program ID to which the account belongs within your organization.",
"examples": [
"12345678"
]
},
"asset_type": {
"type": "string",
"title": "Asset type",
"description": "Financial instrument type",
"enum": [
"cdb",
"rdb"
]
},
"registration_mode": {
"type": "string",
"title": "Registration mode",
"description": "Registration mode of asset",
"examples": [
"investments",
"savings"
]
},
"issuing_date": {
"type": "string",
"title": "Issuing date",
"description": "Date asset was effectively issued by client",
"format": "date",
"examples": [
"2020-12-01"
]
},
"maturity_date": {
"type": "string",
"title": "Issuing date",
"description": "Date asset expires, finishing `issued_units` cycle",
"format": "date",
"examples": [
"2022-12-01"
]
},
"unit_value": {
"type": "number",
"title": "Unit value",
"description": "Value of the asset's units",
"format": "double",
"examples": [
1.0
]
},
"index_type": {
"type": "string",
"title": "Index type",
"description": "Daily accrual calculations are be based on the index type. For example, \"di\" for DI rate or \"pre\" for prefixed rate.",
"enum": [
"di",
"pre"
]
},
"index_rate": {
"type": "number",
"title": "Index rate",
"description": "How much the asset accrues per day",
"format": "double",
"examples": [
1.0
]
},
"interest_rate": {
"type": "number",
"title": "Interest rate",
"description": "How much the asset accrues per day",
"format": "double",
"examples": [
1.0
]
},
"currency_code": {
"type": "string",
"title": "Currency code",
"description": "ISO 4217 currency code",
"examples": [
"986"
]
},
"early_redemption_attributes": {
"type": "array",
"title": "List of early redemption attributes",
"items": {
"$ref": "#/definitions/early_redemption_attributes"
}
},
"has_redemption_condition": {
"type": "string",
"title": "Has Redemption Condition",
"description": "Asset identifier with different types of redemption conditions",
"examples": [
"YES",
"NO",
"MARKET"
]
}
}
},
"quota": {
"type": "object",
"title": "Quota registered",
"required": [
"issued_units",
"external_account_id",
"external_quota_id"
],
"properties": {
"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"
]
},
"customer_type": {
"type": "string",
"title": "Entity type",
"description": "Legal nature of asset quota owner",
"enum": [
"natural",
"legal"
]
},
"issued_units": {
"type": "number",
"title": "Purchased quota units",
"description": "Number of quota units purchased by asset quota owner",
"format": "double",
"examples": [
100.0
]
},
"external_account_id": {
"type": [
"string",
"null"
],
"title": "External account identifier",
"description": "A custom account ID string that uniquely identifies the account within your organization.",
"examples": [
999999999
]
},
"external_quota_id": {
"type": "string",
"title": "External ID",
"description": "External identifier for operation.",
"examples": [
"deposit:6104253a-qt53-41m0-a630-2z1h2761e3f8"
]
}
}
},
"created_at": {
"type": "string",
"title": "Created date",
"description": "Creation date of asset on Pismo platform",
"format": "date-time",
"examples": [
"2020-12-29T19:48:25"
]
}
},
"definitions": {
"early_redemption_attributes": {
"type": "object",
"title": "Early redemption attributes",
"required": [
"date"
],
"description": "Custom redemption conditions",
"properties": {
"date": {
"type": "string",
"format": "date",
"title": "Date",
"description": "Custom date to be considered",
"examples": [
"2021-02-01"
]
},
"interest_rate": {
"type": "number",
"format": "double",
"title": "Interest rate",
"description": "Interest rate to be considered until date established",
"examples": [
1.09
]
},
"floating_rate": {
"type": "number",
"format": "double",
"title": "Floating rate",
"description": "Floating rate to be considered until date established",
"examples": [
1.18
]
}
}
}
}
}
{
"asset": {
"asset_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
"external_asset_id": "kxBHNMCAYDnQav",
"program_id": "12345678",
"asset_type": "cdb",
"registration_mode": "investments",
"issuing_date": "2020-12-01",
"maturity_date": "2022-12-01",
"unit_value": 1.0,
"index_type": "di",
"index_rate": 1.0,
"interest_rate": 1.0,
"currency_code": "986",
"early_redemption_attributes": {
"date": "2021-02-01",
"interest_rate": 1.09,
"floating_rate": 1.18
},
"has_redemption_condition": "YES"
},
"quota": {
"customer_name": "Lorem ipsum",
"customer_document_number": "00000000012",
"customer_type": "natural",
"issued_units": 100.0,
"external_account_id": 999999999,
"external_quota_id": "deposit:6104253a-qt53-41m0-a630-2z1h2761e3f8"
},
"created_at": "2020-12-29T19:48:25"
}
Updated 2 days ago