Bulk settlement processing status changed
Type: object
Domain: corporate
Event: bulk_settlement
Version: 1
bulk_id required
Title: Bulk ID
Description: ID of the bulk settlement request
Type: string
Min length: 1
Max length: 60
Example:
UK1-eb75c472-a213-41a7-a96e-ac0156b832f0
type required
Title: Type
Description: The type of the operation to be executed
Type: string
Must be one of the following:
future-dated
float-payment
Example:
float-payment
settlement_date required
Title: Settlement Date
Description: Business date within Pismo for when the clearing will be settled
Type: string
Format: date
Example:
2022-12-20
division_code required
Title: Division Code
Description: Code string that uniquely identifies the division within your organization.
Type: string
Max length: 36
Example:
division-code-123
division_id required
Title: Division ID
Description: Division unique identifier generated by Pismo
Type: string
Min length: 1
Max length: 36
Example:
7c6138a3-0daa-4a49-aa76-fa03294146b2
division_timezone required
Title: Division Timezone
Description: The timezone of this division. This value will be used when calculating holidays, weekends and daily balances. The format is based on timezone database standards.
Type: string or null
Min length: 0
Max length: 255
Example:
America/Sao_Paulo
US/Central
America/New_York
status required
Title: Status
Description:
It only accepts the following values:
CREATED: When the request is accepted and created.
STARTING_SETTLEMENT: Will settle transactions soon.
NO_QUERY_RESULTS_RETURNED: Query did not return any results based on the request parameters.
FINISHED: All transactions processed for the given parameters.
FAILED: After created, if something went wrong the event will be emitted.
Type: string
Must be one of the following:
CREATED
STARTING_SETTLEMENT
NO_QUERY_RESULTS_RETURNED
FINISHED
FAILED
Example:
FINISHED
created_at required
Title: Created At
Description: Bulk settlement creation datetime
Type: string
Max length: 24
Example:
2023-08-14T22:14:48.636Z
finished_at
Title: Finished At
Description: Bulk settlement finish datetime
Type: string
Max length: 24
Example:
2023-08-14T22:14:48.636Z
failed_at
Title: Finished At
Description: Bulk settlement finish datetime if failed
Type: string
Max length: 24
Example:
2023-08-14T22:14:48.636Z
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Bulk settlement processing status changed",
"required": [
"bulk_id",
"type",
"settlement_date",
"division_code",
"division_id",
"division_timezone",
"status",
"created_at"
],
"properties": {
"bulk_id": {
"type": "string",
"title": "Bulk ID",
"description": "ID of the bulk settlement request",
"minLength": 1,
"maxLength": 60,
"examples": [
"UK1-eb75c472-a213-41a7-a96e-ac0156b832f0"
]
},
"type": {
"type": "string",
"title": "Type",
"description": "The type of the operation to be executed",
"enum": [
"future-dated",
"float-payment"
],
"examples": [
"float-payment"
]
},
"settlement_date": {
"type": "string",
"title": "Settlement Date",
"description": "Business date within Pismo for when the clearing will be settled",
"format": "date",
"examples": [
"2022-12-20"
]
},
"division_code": {
"type": "string",
"title": "Division Code",
"description": "Code string that uniquely identifies the division within your organization.",
"maxLength": 36,
"examples": [
"division-code-123"
]
},
"division_id": {
"title": "Division ID",
"description": "Division unique identifier generated by Pismo",
"type": "string",
"minLength": 1,
"maxLength": 36,
"examples": [
"7c6138a3-0daa-4a49-aa76-fa03294146b2"
]
},
"division_timezone": {
"title": "Division Timezone",
"description": "The timezone of this division. This value will be used when calculating holidays, weekends and daily balances. The format is based on timezone database standards.",
"type": [
"string",
"null"
],
"minLength": 0,
"maxLength": 255,
"examples": [
"America/Sao_Paulo",
"US/Central",
"America/New_York"
]
},
"status": {
"title": "Status",
"description": "\n\nIt only accepts the following values:\n\n<span style='font-weight:bold'>CREATED:</span> When the request is accepted and created.\n\n<span style='font-weight:bold'>STARTING_SETTLEMENT:</span> Will settle transactions soon.\n\n<span style='font-weight:bold'>NO_QUERY_RESULTS_RETURNED:</span> Query did not return any results based on the request parameters.\n\n<span style='font-weight:bold'>FINISHED:</span> All transactions processed for the given parameters.\n\n<span style='font-weight:bold'>FAILED:</span> After created, if something went wrong the event will be emitted.\n\n",
"type": "string",
"enum": [
"CREATED",
"STARTING_SETTLEMENT",
"NO_QUERY_RESULTS_RETURNED",
"FINISHED",
"FAILED"
],
"examples": [
"FINISHED"
]
},
"created_at": {
"type": "string",
"title": "Created At",
"description": "Bulk settlement creation datetime",
"maxLength": 24,
"examples": [
"2023-08-14T22:14:48.636Z"
]
},
"finished_at": {
"type": "string",
"title": "Finished At",
"description": "Bulk settlement finish datetime",
"maxLength": 24,
"examples": [
"2023-08-14T22:14:48.636Z"
]
},
"failed_at": {
"type": "string",
"title": "Finished At",
"description": "Bulk settlement finish datetime if failed",
"maxLength": 24,
"examples": [
"2023-08-14T22:14:48.636Z"
]
}
}
}
{
"bulk_id": "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0",
"type": "float-payment",
"settlement_date": "2022-12-20",
"division_code": "division-code-123",
"division_id": "7c6138a3-0daa-4a49-aa76-fa03294146b2",
"division_timezone": "America/Sao_Paulo",
"status": "FINISHED",
"created_at": "2023-08-14T22:14:48.636Z",
"finished_at": "2023-08-14T22:14:48.636Z",
"failed_at": "2023-08-14T22:14:48.636Z"
}
Updated 19 days ago