Instant pay scheduler status changed
Pix instant pay scheduler actions generate this event. The Schedule transfers V2 and Cancel scheduled transfer V2 endpoints generate this event.
Type: object
Domain: instantpay-scheduler
Event: scheduler_status_change
Version: 1
id required
Title: Scheduler ID
Description: Scheduler identifier.
Type: string
Example:
BBA99AF1-0843-451E-A8C9-2EF5D20C5276
domain required
Title: Domain
Description: Scheduler domain ID.
Type: string
status required
Title: Status
Description: Scheduler status
Type: string
Must be one of the following:
ACTIVE
INACTIVE
CANCELLED
COMPLETED
Example:
ACTIVE
start_date required
Title: Start date
Description: Scheduler start date. Format = yyyy-mm-dd
Type: string
Format: date
Example:
2024-12-12
end_date required
Title: End date
Description: Scheduler end date. Format = yyyy-mm-dd
Type: string
Format: date
Example:
2024-12-12
type required
Title: Type
Description: Scheduler type.
Type: string
Must be one of the following:
RECURRING
ONCE
Example:
RECURRING
day_type required
Title: Day type
Description: Scheduler day type
Type: string
Must be one of the following:
CALENDAR
BUSINESS
Example:
CALENDAR
interval required
Title: Interval
Description: Scheduler interval type.
Type: string
Must be one of the following:
MONTH
WEEK
DAY
Example:
MONTH
description
Title: Description
Description: Scheduler description.
Type: string
Example:
Pix out scheduler
continue_even_failed required
Title: Continue even failed
Description: If true, the next run is scheduled, even if the current run fails.
Type: boolean
Example:
true
execution_hour required
Title: Execution hour
Description: Time when scheduler executes. Format = HH:MM:SS.
Type: string
Example:
00:00:00
retry_hour required
Title: Execution retry hour
Description: Time when scheduler is retried in case of initial execution failure. Format = HH:MM:SS.
Type: string
Example:
22:00:00
created_at required
Title: Created at
Description: Scheduler creation datetime. RFC 3339 format.
Type: string
Format: date-time
Example:
2024-12-12T11:00:00.000Z
updated_at required
Title: Updated at
Description: Scheduler last modified datetime. RCF 3339 format.
Type: string
Format: date-time
Example:
2024-12-12T11:00:00.000Z
account_id
Title: Account ID
Description: Pismo account ID.
Type: integer
error
Title: Error
Description: If a scheduling processing failure generates this event, details why will appear here.
Type: objectmessage required
Title: Message
Description: Error message
Type: stringcode required
Title: Code
Description: Error code
Type: string
{
"$schema": "http://json-schema.org/draft-07/schema",
"type": "object",
"title": "Instant pay scheduler status changed",
"description": "Pix instant pay scheduler actions generate this event. The <a href='https://developers.pismo.io/pismo-docs/reference/delete-cancel-pix-out'>Schedule transfers V2</a> and <a href='https://developers.pismo.io/pismo-docs/reference/post-schedule-pix-payment'>Cancel scheduled transfer V2</a> endpoints generate this event.",
"required": [
"id",
"domain",
"status",
"start_date",
"end_date",
"type",
"day_type",
"interval",
"continue_even_failed",
"execution_hour",
"retry_hour",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"title": "Scheduler ID",
"description": "Scheduler identifier.",
"examples": [
"BBA99AF1-0843-451E-A8C9-2EF5D20C5276"
]
},
"domain": {
"type": "string",
"title": "Domain",
"description": "Scheduler domain ID.",
"enun": [
"pix",
"pix-out-scheduled"
]
},
"status": {
"type": "string",
"title": "Status",
"description": "Scheduler status",
"enum": [
"ACTIVE",
"INACTIVE",
"CANCELLED",
"COMPLETED"
],
"examples": [
"ACTIVE"
]
},
"start_date": {
"type": "string",
"format": "date",
"title": "Start date",
"description": "Scheduler start date. Format = yyyy-mm-dd",
"examples": [
"2024-12-12"
]
},
"end_date": {
"type": "string",
"format": "date",
"title": "End date",
"description": "Scheduler end date. Format = yyyy-mm-dd",
"examples": [
"2024-12-12"
]
},
"type": {
"type": "string",
"title": "Type",
"description": "Scheduler type.",
"enum": [
"RECURRING",
"ONCE"
],
"examples": [
"RECURRING"
]
},
"day_type": {
"type": "string",
"title": "Day type",
"description": "Scheduler day type",
"enum": [
"CALENDAR",
"BUSINESS"
],
"examples": [
"CALENDAR"
]
},
"interval": {
"type": "string",
"title": "Interval",
"description": "Scheduler interval type.",
"enum": [
"MONTH",
"WEEK",
"DAY"
],
"examples": [
"MONTH"
]
},
"description": {
"type": "string",
"title": "Description",
"description": "Scheduler description.",
"examples": [
"Pix out scheduler"
]
},
"continue_even_failed": {
"type": "boolean",
"title": "Continue even failed",
"description": "If true, the next run is scheduled, even if the current run fails.",
"examples": [
true
]
},
"execution_hour": {
"type": "string",
"title": "Execution hour",
"description": "Time when scheduler executes. Format = HH:MM:SS.",
"examples": [
"00:00:00"
]
},
"retry_hour": {
"type": "string",
"title": "Execution retry hour",
"description": "Time when scheduler is retried in case of initial execution failure. Format = HH:MM:SS.",
"examples": [
"22:00:00"
]
},
"created_at": {
"type": "string",
"title": "Created at",
"description": "Scheduler creation datetime. RFC 3339 format.",
"format": "date-time",
"examples": [
"2024-12-12T11:00:00.000Z"
]
},
"updated_at": {
"type": "string",
"title": "Updated at",
"description": "Scheduler last modified datetime. RCF 3339 format.",
"format": "date-time",
"examples": [
"2024-12-12T11:00:00.000Z"
]
},
"account_id": {
"type": "integer",
"title": "Account ID",
"description": "Pismo account ID."
},
"error": {
"title": "Error",
"type": "object",
"description": "If a scheduling processing failure generates this event, details why will appear here.",
"properties": {
"message": {
"type": "string",
"title": "Message",
"description": "Error message"
},
"code": {
"type": "string",
"title": "Code",
"description": "Error code"
}
},
"required": [
"message",
"code"
]
}
},
"examples": [
{
"domain": "instantpay-scheduler",
"event_type": "scheduler_status_change",
"schema_version": 1,
"org_id": "4ea21a59-7f4f-4087-aab6-a9a96733084a",
"cid": "cid",
"timestamp": "2023-10-25T18:29:19Z",
"data": {
"id": "51a7e875-35a5-4c81-aa77-51bdf3090835",
"domain": "pix-out-scheduled",
"account_id": 123456,
"description": "Pix out scheduler",
"status": "ACTIVE",
"start_date": "2024-10-13",
"end_date": "2024-12-12",
"type": "RECURRING",
"day_type": "CALENDAR",
"interval": "MONTH",
"continue_even_failed": true,
"execution_hour": "00:00:00",
"retry_hour": "22:00:00",
"error": {
"message": "",
"code": ""
}
}
}
]
}
Updated 12 days ago