Pix DICT synchronized

(Internal only) Event that represents a Pix DICT synchronization between Pismo Platform and the Central Bank of Braziil

Type: object
Domain: pix-dict
Event: synchronism_result
Version: 1

job_id required

Title: Job ID
Description: Identifier of the process that executed the synchronization
Type: string
Example:
91d65e98-97c0-4b0f-b577-73625da1f9fc

correlation_id

Title: Correlation ID
Description: Correlation identifier for operational support
Type: string or null
Example:
B20220921145635222303062944CA66F

key_type required

Title: Key Type
Description: Type of Pix key that was used in this synchronization
Type: string
Example:
CPF
CNPJ
PHONE
EMAIL
EVP

participant required

Title: Participant
Description: Pix Participant ID registered with Central Bank of Brazil
Type: string
Example:
00000000
60746948

result required

Title: Result
Description: Final result of the synchronization process
Type: string
Example:
OK
NOK

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Pix DICT synchronized",
    "description": "(Internal only) Event that represents a Pix DICT synchronization between Pismo Platform and the Central Bank of Braziil",
    "required": [
        "job_id",
        "key_type",
        "participant",
        "result"
    ],
    "properties": {
        "job_id": {
            "type": "string",
            "title": "Job ID",
            "description": "Identifier of the process that executed the synchronization",
            "examples": [
                "91d65e98-97c0-4b0f-b577-73625da1f9fc"
            ]
        },
        "correlation_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "Correlation ID",
            "description": "Correlation identifier for operational support",
            "examples": [
                "B20220921145635222303062944CA66F"
            ]
        },
        "key_type": {
            "type": "string",
            "title": "Key Type",
            "description": "Type of Pix key that was used in this synchronization",
            "examples": [
                "CPF",
                "CNPJ",
                "PHONE",
                "EMAIL",
                "EVP"
            ]
        },
        "participant": {
            "type": "string",
            "title": "Participant",
            "description": "Pix Participant ID registered with Central Bank of Brazil",
            "examples": [
                "00000000",
                "60746948"
            ]
        },
        "result": {
            "type": "string",
            "title": "Result",
            "description": "Final result of the synchronization process",
            "examples": [
                "OK",
                "NOK"
            ]
        }
    }
}

{
    "job_id": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
    "correlation_id": "B20220921145635222303062944CA66F",
    "key_type": "CPF",
    "participant": "00000000",
    "result": "OK"
}