Interest withdrawal succeeded
This event occurs when withdrawal occurs with product interest-management.
Type: object
Domain: interest-management
Event: interest_withdrawal_success
Version: 1
tracking_id required
Title: Tracking ID.
Description: Unique withdrawal 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
customer_document_number
Title: Customer document number
Description: Number of withdrawal owner's legal document
Type: string
Example:
00000000012
created_at required
Title: Created date
Description: Creation date of withdrawal on Pismo platform
Type: string
Format: date-time
Example:
2020-12-29T19:48:25
withdrawal_date required
Title: Value date
Description: Date that withdrawal was effectively issued by client
Type: string
Format: date
Example:
2020-12-01
currency_code required
Title: Currency code
Description: ISO 4217 currency code
Type: string
Example:
986
net_withdrawn_amount required
Title: Net Amount withdrawn
Description: Net Value to be withdrawn from account deposit
Type: number
Format: double
Example:
100.0
gross_withdrawn_amount required
Title: Gross Amount withdrawn
Description: Gross Value to be withdrawn from account deposit
Type: number
Format: double
Example:
100.0
taxes required
Title: List of taxes
Description: Taxes to be applied to withdrawal
Type: arrayname required
Title: Tax Name
Description: Tax Name.
Type: string
Example:
IR
IOF
amount required
Title: Tax Amount
Description: Tax Amount.
Type: number
Format: double
Example:
0.15
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Interest withdrawal succeeded",
"description": "This event occurs when withdrawal occurs with product interest-management.",
"required": [
"tracking_id",
"account_id",
"created_at",
"withdrawal_date",
"currency_code",
"net_withdrawn_amount",
"gross_withdrawn_amount",
"taxes"
],
"properties": {
"tracking_id": {
"type": "string",
"title": "Tracking ID.",
"description": "Unique withdrawal 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"
]
},
"customer_document_number": {
"type": "string",
"title": "Customer document number",
"description": "Number of withdrawal owner's legal document",
"examples": [
"00000000012"
]
},
"created_at": {
"type": "string",
"title": "Created date",
"description": "Creation date of withdrawal on Pismo platform",
"format": "date-time",
"examples": [
"2020-12-29T19:48:25"
]
},
"withdrawal_date": {
"type": "string",
"title": "Value date",
"description": "Date that withdrawal was effectively issued by client",
"format": "date",
"examples": [
"2020-12-01"
]
},
"currency_code": {
"type": "string",
"title": "Currency code",
"description": "ISO 4217 currency code",
"examples": [
"986"
]
},
"net_withdrawn_amount": {
"type": "number",
"title": "Net Amount withdrawn",
"description": "Net Value to be withdrawn from account deposit",
"format": "double",
"examples": [
100.0
]
},
"gross_withdrawn_amount": {
"type": "number",
"title": "Gross Amount withdrawn",
"description": "Gross Value to be withdrawn from account deposit",
"format": "double",
"examples": [
100.0
]
},
"taxes": {
"type": "array",
"title": "List of taxes",
"items": {
"$ref": "#/definitions/taxes"
}
}
},
"definitions": {
"taxes": {
"type": "object",
"title": "Taxes attributes",
"required": [
"name",
"amount"
],
"description": "Taxes to be applied to withdrawal",
"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
]
}
}
}
}
}
{
"tracking_id": "d0855c6b-b037-4dce-94c5-7a6ffc1800a3",
"account_id": "999999999",
"customer_document_number": "00000000012",
"created_at": "2020-12-29T19:48:25",
"withdrawal_date": "2020-12-01",
"currency_code": "986",
"net_withdrawn_amount": 100.0,
"gross_withdrawn_amount": 100.0,
"taxes": {
"name": "IR",
"amount": 0.15
}
}
Updated 3 days ago