Interest deposit failed
This event occurs when there is a failure in interest deposit registration with product interest-management.
Type: object
Domain: interest-management
Event: interest_deposit_failure
Version: 1
tracking_id required
Title: Tracking ID.
Description: Unique deposit identifier defined by Customer.
Type: string
Example:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3
account_id required
Title: Account identifier
Description: A custom account ID string that uniquely identifies the account within your organization.
Type: string
Example:
999999999
interest_plan_id required
Title: Interest Plan ID identifier
Description: A custom identifier string that indicates the interest plan to be used in the rate calculations.
Type: string
Example:
999999999
amount
Title: Deposit Amount
Description: Deposit Amount, monetary value.
Type: number
Format: double
Example:
0.15
value_date
Title: Value date
Description: Date that deposit was effectively issued by client
Type: string
Format: date
Example:
2020-12-01
maturity_date
Title: Issuing date
Description: Date that deposit expires, finishing rentability cycle
Type: string
Format: date
Example:
2022-12-01
has_asset_registration
Title: Has Asset Registration
Description: Indicates if the interest deposit must be registered as a asset
Type: objectcustomer_name required
Title: Customer name
Description: Name of interest deposit owner. Can be a company or an individual.
Type: string
Example:
Lorem ipsum
document_number required
Title: Customer document number
Description: Number of interest deposit owner's legal document
Type: string
Example:
00000000012
customer_type required
Title: Entity type
Description: Legal nature of interest deposit owner
Type: string
Must be one of the following:
natural
legal
message required
Title: Error message
Description: Description of error that occurred when trying to register new deposit
Type: string
Example:
The informed interest_plan_id does not exist.
created_at
Title: Created date
Description: Creation date of interest deposit 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 deposit failed",
"description": "This event occurs when there is a failure in interest deposit registration with product interest-management.",
"required": [
"tracking_id",
"account_id",
"interest_plan_id",
"message"
],
"properties": {
"tracking_id": {
"type": "string",
"title": "Tracking ID.",
"description": "Unique deposit identifier defined by Customer.",
"examples": [
"d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
]
},
"account_id": {
"type": "string",
"title": "Account identifier",
"description": "A custom account ID string that uniquely identifies the account within your organization.",
"examples": [
999999999
]
},
"interest_plan_id": {
"type": "string",
"title": "Interest Plan ID identifier",
"description": "A custom identifier string that indicates the interest plan to be used in the rate calculations.",
"examples": [
999999999
]
},
"amount": {
"type": "number",
"title": "Deposit Amount",
"description": "Deposit Amount, monetary value.",
"format": "double",
"examples": [
0.15
]
},
"value_date": {
"type": "string",
"title": "Value date",
"description": "Date that deposit was effectively issued by client",
"format": "date",
"examples": [
"2020-12-01"
]
},
"maturity_date": {
"type": "string",
"title": "Issuing date",
"description": "Date that deposit expires, finishing rentability cycle",
"format": "date",
"examples": [
"2022-12-01"
]
},
"has_asset_registration": {
"type": "object",
"title": "Has Asset Registration",
"description": "Indicates if the interest deposit must be registered as a asset",
"required": [
"document_number",
"customer_name",
"customer_type"
],
"properties": {
"customer_name": {
"type": "string",
"title": "Customer name",
"description": "Name of interest deposit owner. Can be a company or an individual.",
"examples": [
"Lorem ipsum"
]
},
"document_number": {
"type": "string",
"title": "Customer document number",
"description": "Number of interest deposit owner's legal document",
"examples": [
"00000000012"
]
},
"customer_type": {
"type": "string",
"title": "Entity type",
"description": "Legal nature of interest deposit owner",
"enum": [
"natural",
"legal"
]
}
}
},
"message": {
"type": "string",
"title": "Error message",
"description": "Description of error that occurred when trying to register new deposit",
"examples": [
"The informed interest_plan_id does not exist."
]
},
"created_at": {
"type": "string",
"title": "Created date",
"description": "Creation date of interest deposit on Pismo platform",
"format": "date-time",
"examples": [
"2020-12-29T19:48:25"
]
}
}
}
{
"tracking_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
"account_id": 999999999,
"interest_plan_id": 999999999,
"amount": 0.15,
"value_date": "2020-12-01",
"maturity_date": "2022-12-01",
"has_asset_registration": {
"customer_name": "Lorem ipsum",
"document_number": "00000000012",
"customer_type": "natural"
},
"message": "The informed interest_plan_id does not exist.",
"created_at": "2020-12-29T19:48:25"
}
Updated 4 days ago