Instantpay execution status changed

Internal-only endpoint. This event is triggered by scheduled executions actions in instantpay services. For example, when execute scheduled PIX.

Type: object
Domain: instantpay-scheduler
Event: execution_status_change
Version: 1

scheduler_id required

Title: Scheduler ID
Description: Scheduler identifier.
Type: string
Example:
BBA99AF1-0843-451E-A8C9-2EF5D20C5276

execution_id required

Title: Execution ID
Description: Execution incremental identifier.
Type: integer
Example:
1

status required

Title: Status
Description: Status of execution
Type: string
Must be one of the following:
PENDING
EXECUTING
SUCCESS
FAIL
CANCELLED
Example:
SUCCESS

execution_datetime required

Title: Start date
Description: Date of execution
Type: string
Format: date-time
Example:
2024-12-12T11:00:00.000Z

created_at required

Title: Created at
Description: Date of criate execution
Type: string
Format: date-time
Example:
2024-12-12T11:00:00.000Z

updated_at

Title: Updated at
Description: Date of update execution
Type: string
Format: date-time
Example:
2024-12-12T11:00:00.000Z

status_history

Type: array

created_at required

Title: Created at
Description: Date of criate execution
Type: string
Format: date-time
Example:
2024-12-12T11:00:00.000Z

status required

Title: Status
Description: Status of execution
Type: string
Must be one of the following:
PENDING
EXECUTING
SUCCESS
FAIL
CANCELLED
Example:
SUCCESS

cid required

Title: CID
Description: Pismo CID of execution
Type: string
Example:
BBA99AF1-0843-451E-A8C9-2EF5D20C5276

error

Title: Error
Description: If the event was caused by a scheduling processing failure, you will receive more details here.
Type: object

message required

Title: Message
Description: Error message
Type: string

code required

Title: Code
Description: Error code
Type: string

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Instantpay execution status changed",
    "description": "Internal-only endpoint. This event is triggered by scheduled executions actions in instantpay services. For example, when execute scheduled PIX.",
    "examples": [
        {
            "domain": "instantpay-scheduler",
            "event_type": "execution_status_change",
            "schema_version": 1,
            "org_id": "4ea21a59-7f4f-4087-aab6-a9a96733084a",
            "cid": "cid",
            "timestamp": "2023-10-25T18:29:19Z",
            "data": {
                "scheduler_id": "51a7e875-35a5-4c81-aa77-51bdf3090835",
                "execution_id": 1,
                "execution_datetime": "2024-10-13T00:00:00Z",
                "status": "PENDING",
                "created_at": "2024-10-17T12:49:50Z",
                "updated_at": "2024-10-17T12:49:50Z",
                "status_history": [
                    {
                        "created_at": "2024-10-17T12:49:50Z",
                        "status": "SUCCESS",
                        "cid": "51a7e875-35a5-4c81-aa77-51bdf3090835"
                    }
                ],
                "error": {
                    "message": "",
                    "code": ""
                }
            }
        }
    ],
    "properties": {
        "scheduler_id": {
            "type": "string",
            "title": "Scheduler ID",
            "description": "Scheduler identifier.",
            "examples": [
                "BBA99AF1-0843-451E-A8C9-2EF5D20C5276"
            ]
        },
        "execution_id": {
            "type": "integer",
            "title": "Execution ID",
            "description": "Execution incremental identifier.",
            "examples": [
                1
            ]
        },
        "status": {
            "type": "string",
            "title": "Status",
            "description": "Status of execution",
            "enum": [
                "PENDING",
                "EXECUTING",
                "SUCCESS",
                "FAIL",
                "CANCELLED"
            ],
            "examples": [
                "SUCCESS"
            ]
        },
        "execution_datetime": {
            "type": "string",
            "title": "Start date",
            "description": "Date of execution",
            "format": "date-time",
            "examples": [
                "2024-12-12T11:00:00.000Z"
            ]
        },
        "created_at": {
            "type": "string",
            "title": "Created at",
            "description": "Date of criate execution",
            "format": "date-time",
            "examples": [
                "2024-12-12T11:00:00.000Z"
            ]
        },
        "updated_at": {
            "type": "string",
            "title": "Updated at",
            "description": "Date of update execution",
            "format": "date-time",
            "examples": [
                "2024-12-12T11:00:00.000Z"
            ]
        },
        "status_history": {
            "title": "Status history",
            "type": "array",
            "description": "List with the history of execution status",
            "items": [
                {
                    "type": "object",
                    "properties": {
                        "created_at": {
                            "type": "string",
                            "title": "Created at",
                            "description": "Date of criate execution",
                            "format": "date-time",
                            "examples": [
                                "2024-12-12T11:00:00.000Z"
                            ]
                        },
                        "status": {
                            "type": "string",
                            "title": "Status",
                            "description": "Status of execution",
                            "enum": [
                                "PENDING",
                                "EXECUTING",
                                "SUCCESS",
                                "FAIL",
                                "CANCELLED"
                            ],
                            "examples": [
                                "SUCCESS"
                            ]
                        },
                        "cid": {
                            "type": "string",
                            "title": "CID",
                            "description": "Pismo CID of execution",
                            "examples": [
                                "BBA99AF1-0843-451E-A8C9-2EF5D20C5276"
                            ]
                        }
                    },
                    "required": [
                        "created_at",
                        "status",
                        "cid"
                    ]
                }
            ]
        },
        "error": {
            "title": "Error",
            "type": "object",
            "description": "If the event was caused by a scheduling processing failure, you will receive more details here.",
            "properties": {
                "message": {
                    "type": "string",
                    "title": "Message",
                    "description": "Error message"
                },
                "code": {
                    "type": "string",
                    "title": "Code",
                    "description": "Error code"
                }
            },
            "required": [
                "message",
                "code"
            ]
        }
    },
    "required": [
        "scheduler_id",
        "execution_id",
        "execution_datetime",
        "status",
        "created_at"
    ]
}

Updated about 13 hours ago