Savings account product withdrawal confirmation
Savings account product withdrawal confirmed.
Type: object
Domain: savings-account-product
Event: withdrawal_confirmed
Version: 1
external_id required
Title: External ID
Description: External event identifier, it can be eithertracking_id
orbalance_id
.
Type: string
Format: uuid
Example:
02c1f997-e57a-488a-9ace-7731f5b7e25d
account_id required
Title: Account ID
Description: Account ID, it can be either internal or external to Pismo.
Type: integer
Example:
123
program_id required
Title: Program ID
Description: Program ID of the account performing the operation.
Type: integer
Example:
123
product_id required
Title: Product ID
Description: Pismo product ID.
Type: string
Format: uuid
Example:
4aa5556f-8062-4705-9aca-7246c4d1f36d
amount required
Title: Amount
Description: Withdrawal amount.
Type: number
Format: double
Example:
10.14
withdrawal_date required
Title: Withdrawal Date
Description: The date when the withdrawal is made.
Type: string
Format: date
Example:
2024-10-15
status required
Title: Status
Description: Status of the withdrawal product.
Type: string
Must be one of the following:
CONFIRMED
CONFIRMATION_ERROR
error_message
Title: Error message
Description: Detailed error message if the withdrawal product registration fails.
Type: string
Example:
Error message
withdrawal_id required
Title: Withdrawal ID
Description: Unique identifier for the withdrawal.
Type: string
Format: uuid
Example:
02c1f997-e57a-488a-9ace-7731f5b7e25d
taxes
Type: array
name required
Title: Tax Name
Description: Name of the tax.
Type: string
Example:
IR
amount required
Title: Tax Amount
Description: Amount of the tax.
Type: number
Format: double
Example:
0.15
created_at required
Title: Creation date time
Description: Withdrawal product creation date time.
Type: string
Format: date-time
Example:
2024-10-15T13:26:25Z
update_at required
Title: Update date time
Description: Withdrawal product update date time.
Type: string
Format: date-time
Example:
2024-10-15T13:30:25Z
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Savings account product withdrawal confirmation",
"description": "Savings account product withdrawal confirmed.",
"required": [
"external_id",
"account_id",
"program_id",
"product_id",
"amount",
"withdrawal_date",
"status",
"withdrawal_id",
"created_at",
"update_at"
],
"properties": {
"external_id": {
"type": "string",
"format": "uuid",
"title": "External ID",
"description": "External event identifier, it can be either `tracking_id` or `balance_id`.",
"examples": [
"02c1f997-e57a-488a-9ace-7731f5b7e25d"
]
},
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "Account ID, it can be either internal or external to Pismo.",
"examples": [
123
]
},
"program_id": {
"type": "integer",
"title": "Program ID",
"description": "Program ID of the account performing the operation.",
"examples": [
123
]
},
"product_id": {
"type": "string",
"format": "uuid",
"title": "Product ID",
"description": "Pismo product ID.",
"examples": [
"4aa5556f-8062-4705-9aca-7246c4d1f36d"
]
},
"amount": {
"type": "number",
"format": "double",
"title": "Amount",
"description": "Withdrawal amount.",
"examples": [
10.14
]
},
"withdrawal_date": {
"type": "string",
"format": "date",
"title": "Withdrawal Date",
"description": "The date when the withdrawal is made.",
"examples": [
"2024-10-15"
]
},
"status": {
"type": "string",
"title": "Status",
"description": "Status of the withdrawal product.",
"enum": [
"CONFIRMED",
"CONFIRMATION_ERROR"
]
},
"error_message": {
"type": "string",
"title": "Error message",
"description": "Detailed error message if the withdrawal product registration fails.",
"examples": [
"Error message"
]
},
"withdrawal_id": {
"type": "string",
"format": "uuid",
"title": "Withdrawal ID",
"description": "Unique identifier for the withdrawal.",
"examples": [
"02c1f997-e57a-488a-9ace-7731f5b7e25d"
]
},
"taxes": {
"type": "array",
"title": "Taxes",
"description": "List of taxes applied to the withdrawal.",
"items": {
"type": "object",
"required": [
"name",
"amount"
],
"properties": {
"name": {
"type": "string",
"title": "Tax Name",
"description": "Name of the tax.",
"examples": [
"IR"
]
},
"amount": {
"type": "number",
"format": "double",
"title": "Tax Amount",
"description": "Amount of the tax.",
"examples": [
0.15
]
}
}
}
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Creation date time",
"description": "Withdrawal product creation date time.",
"examples": [
"2024-10-15T13:26:25Z"
]
},
"update_at": {
"type": "string",
"format": "date-time",
"title": "Update date time",
"description": "Withdrawal product update date time.",
"examples": [
"2024-10-15T13:30:25Z"
]
}
}
}
{
"external_id": "02c1f997-e57a-488a-9ace-7731f5b7e25d",
"account_id": 123,
"program_id": 123,
"product_id": "4aa5556f-8062-4705-9aca-7246c4d1f36d",
"amount": 10.14,
"withdrawal_date": "2024-10-15",
"status": "CONFIRMED",
"error_message": "Error message",
"withdrawal_id": "02c1f997-e57a-488a-9ace-7731f5b7e25d",
"taxes": {
"name": "IR",
"amount": 0.15
},
"created_at": "2024-10-15T13:26:25Z",
"update_at": "2024-10-15T13:30:25Z"
}
Updated 12 days ago