Interest post-balance operation
This event occurs when a redemption or registration needs to happen based on the post-balance feature
Type: object
Domain: interest-management
Event: interest_post_balance_banking
Version: 1
org_id required
Title: Organization ID
Description: Organization/tenant ID.
Type: string
Example:
TN-1234
program_id required
Title: Program identification
Description: Program ID to which the account belongs within your organization.
Type: string
Example:
12345678
balance_id required
Title: Balance ID
Description: Unique balance identifier defined by Pismo.
Type: string
Example:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3
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:
null
asset_id required
Title: Asset ID
Description: Unique asset identifier defined by Pismo.
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:
d0855c6b-b037-4dce-94c5-7a6ffc1800a3
amount required
Title: Registration or redemption Amount based on request_type
Description: Deposit Amount, monetary value.
Type: number
Format: double
Example:
0.15
document_number required
Title: Customer document number
Description: Number of post balance owner's legal document
Type: string
Example:
00000000012
customer_name required
Title: Customer name
Description: Name of post balance owner. Can be a company or an individual.
Type: string
Example:
Lorem ipsum
customer_type required
Title: Entity type
Description: Legal nature of post balance owner
Type: string
Must be one of the following:
natural
legal
request_type required
Title: Entity type
Description: Type of request for banking to call
Type: string
Must be one of the following:
registration
redemption
request_date required
Title: Request Date
Description: Date of the file posting
Type: string
Format: date-time
Example:
2024-01-23T13:26:25
has_asset_registration required
Title: Has Asset Registration
Description: Indicates if the interest deposit must be registered as a asset
Type: boolean
Example:
true
false
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Interest post-balance operation",
"description": "This event occurs when a redemption or registration needs to happen based on the post-balance feature",
"required": [
"org_id",
"program_id",
"balance_id",
"interest_plan_id",
"asset_id",
"account_id",
"amount",
"document_number",
"customer_name",
"customer_type",
"request_type",
"request_date",
"has_asset_registration"
],
"properties": {
"org_id": {
"$id": "#/properties/org_id",
"title": "Organization ID",
"description": "Organization/tenant ID.",
"type": "string",
"examples": [
"TN-1234"
]
},
"program_id": {
"type": "string",
"title": "Program identification",
"description": "Program ID to which the account belongs within your organization.",
"examples": [
"12345678"
]
},
"balance_id": {
"type": "string",
"title": "Balance ID",
"description": "Unique balance identifier defined by Pismo.",
"examples": [
"d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
]
},
"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": [
""
]
},
"asset_id": {
"type": "string",
"title": "Asset ID",
"description": "Unique asset identifier defined by Pismo.",
"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": [
"d0855c6b-b037-4dce-94c5-7a6ffc1800a3"
]
},
"amount": {
"type": "number",
"title": "Registration or redemption Amount based on request_type",
"description": "Deposit Amount, monetary value.",
"format": "double",
"examples": [
0.15
]
},
"document_number": {
"type": "string",
"title": "Customer document number",
"description": "Number of post balance owner's legal document",
"examples": [
"00000000012"
]
},
"customer_name": {
"type": "string",
"title": "Customer name",
"description": "Name of post balance owner. Can be a company or an individual.",
"examples": [
"Lorem ipsum"
]
},
"customer_type": {
"type": "string",
"title": "Entity type",
"description": "Legal nature of post balance owner",
"enum": [
"natural",
"legal"
]
},
"request_type": {
"type": "string",
"title": "Entity type",
"description": "Type of request for banking to call",
"enum": [
"registration",
"redemption"
]
},
"request_date": {
"type": "string",
"title": "Request Date",
"description": "Date of the file posting",
"format": "date-time",
"examples": [
"2024-01-23T13:26:25"
]
},
"has_asset_registration": {
"type": "boolean",
"title": "Has Asset Registration",
"description": "Indicates if the interest deposit must be registered as a asset",
"examples": [
true,
false
]
}
}
}
Updated 3 days ago