Bulk payment processing status changed

Type: object
Domain: corporate
Event: bulk_status_changed
Version: 1

bulk_id required

Title: Unique identifier for bulk processing
Type: string
Min length: 1
Max length: 43
Example:
UK1-eb75c472-a213-41a7-a96e-ac0156b832f0

operation_type required

Title: The type of the operation executed
Type: string
Must be one of the following:
PAYMENT
Example:
PAYMENT

output

Title: Output related information
Type: object

base_path required

Title: The output and signature file base path
Type: string
Min length: 1
Max length: 255
Example:
outgoing/TN-b5019bed-38f0-44a8-b177-3837fc961880/bulk-payments

signature_file required

Title: Signature of the output file
Type: string
Min length: 1
Max length: 255
Example:
2024-09-10-15-58-06-2f0dc5e9-2025-4faa-8f00-4ec31a16c88e-out.sign

original_file required

Title: The original output file
Type: string
Min length: 1
Max length: 255
Example:
2024-09-10-15-58-06-2f0dc5e9-2025-4faa-8f00-4ec31a16c88e-out.original

key_id required

Title: ID of the Pismo's public key used for signing the output file
Type: string
Min length: 1
Max length: 60
Example:
b6cdccc4-f6bf-4218-9e5e-7fb8f66008e3

status required

Title: Bulk processing status
Description:
It only accepts the following values:
CREATED: When the bulk payment has started processing.
FINISHED:When the bulk payment has finished processing.
FAILED: When an error occurred.
WAITING_SIGNATURE: Waiting for Pismo's digital signature to validate the output file's authenticity.
Type: string
Must be one of the following:
CREATED
FINISHED
FAILED
WAITING_SIGNATURE
Example:
FINISHED

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Bulk payment processing status changed",
    "required": [
        "bulk_id",
        "operation_type",
        "status"
    ],
    "properties": {
        "bulk_id": {
            "title": "Unique identifier for bulk processing",
            "type": "string",
            "minLength": 1,
            "maxLength": 43,
            "examples": [
                "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0"
            ]
        },
        "operation_type": {
            "title": "The type of the operation executed",
            "type": "string",
            "enum": [
                "PAYMENT"
            ],
            "examples": [
                "PAYMENT"
            ]
        },
        "output": {
            "title": "Output related information",
            "type": "object",
            "required": [
                "base_path",
                "signature_file",
                "original_file",
                "key_id"
            ],
            "properties": {
                "base_path": {
                    "title": "The output and signature file base path",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255,
                    "examples": [
                        "outgoing/TN-b5019bed-38f0-44a8-b177-3837fc961880/bulk-payments"
                    ]
                },
                "signature_file": {
                    "title": "Signature of the output file",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255,
                    "examples": [
                        "2024-09-10-15-58-06-2f0dc5e9-2025-4faa-8f00-4ec31a16c88e-out.sign"
                    ]
                },
                "original_file": {
                    "title": "The original output file",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255,
                    "examples": [
                        "2024-09-10-15-58-06-2f0dc5e9-2025-4faa-8f00-4ec31a16c88e-out.original"
                    ]
                },
                "key_id": {
                    "title": "ID of the Pismo's public key used for signing the output file",
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 60,
                    "examples": [
                        "b6cdccc4-f6bf-4218-9e5e-7fb8f66008e3"
                    ]
                }
            }
        },
        "status": {
            "title": "Bulk processing status",
            "description": "\n\nIt only accepts the following values:\n\n<span style='font-weight:bold'>CREATED:</span> When the bulk payment has started processing.\n\n<span style='font-weight:bold'>FINISHED:</span>When the bulk payment has finished processing.\n\n<span style='font-weight:bold'>FAILED:</span> When an error occurred.\n\n<span style='font-weight:bold'>WAITING_SIGNATURE:</span> Waiting for Pismo's digital signature to validate the output file's authenticity.\n\n",
            "type": "string",
            "enum": [
                "CREATED",
                "FINISHED",
                "FAILED",
                "WAITING_SIGNATURE"
            ],
            "examples": [
                "FINISHED"
            ]
        }
    }
}

{
    "bulk_id": "UK1-eb75c472-a213-41a7-a96e-ac0156b832f0",
    "operation_type": "PAYMENT",
    "output": {
        "base_path": "outgoing/TN-b5019bed-38f0-44a8-b177-3837fc961880/bulk-payments",
        "signature_file": "2024-09-10-15-58-06-2f0dc5e9-2025-4faa-8f00-4ec31a16c88e-out.sign",
        "original_file": "2024-09-10-15-58-06-2f0dc5e9-2025-4faa-8f00-4ec31a16c88e-out.original",
        "key_id": "b6cdccc4-f6bf-4218-9e5e-7fb8f66008e3"
    },
    "status": "FINISHED"
}

Updated 23 days ago