Pix infraction status changed

Pix infraction creation and status change event. The following endpoints generate this event: Create infraction report, Close infraction report, and Cancel infraction report. For more information, see the Pix instant payments guide. Also see the Pix payments data events guide.

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

creation_time required

Title: Creation Time
Description: Pix infraction report creation datetime on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-29T11:00:00.000Z

credited_participant required

Title: Credited participant
Description: ISPB (Brazilian Payments System) identifier for the Pix user receiving the infraction
Type: string
Max length: 8
Example:
99999011

debited_participant required

Title: Debited participant
Description: ISPB (Brazilian Payments System) identifier for the Pix user paying the infraction
Type: string
Max length: 8
Example:
99999010

infraction_id required

Title: Infraction ID
Description: Pismo-generated Pix infraction ID
Type: string
Example:
91d65e98-97c0-4b0f-b577-73625da1f9fc

infraction_status required

Title: Infraction status
Description: Pix infraction current status
Type: string
Max length: 15
Must be one of the following:
OPEN
ACKNOWLEDGED
CLOSED
CANCELLED
Example:
OPEN

infraction_type required

Title: Infraction type
Description: Pix infraction type
Type: string
Max length: 16
Must be one of the following:
FRAUD
REFUND_REQUEST
REFUND_CANCELLED
Example:
FRAUD

last_modified required

Title: Last Modified
Description: Datetime of most recent infraction report modification. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2021-10-29T11:00:00.000Z

reported_by required

Title: Reported By
Description: Participant who originated the infraction report.
Type: string
Max length: 20
Must be one of the following:
DEBITED_PARTICIPANT
CREDITED_PARTICIPANT
Example:
CREDITED_PARTICIPAMT

transaction_id required

Title: Transaction ID
Description: Pix transaction ID
Type: string
Example:
E9999901012341234123412345678900

analysis_result

Title: Analysis Result
Description: Infraction analysis result
Type: string or null
Must be one of the following:
AGREED
DISAGREED
Example:
AGREED

analysis_details

Title: Analysis details
Description: Details supporting the infraction analysis result
Type: string or null
Max length: 2000

infraction_data

Type: object

credited_participant required

Title: Credited participant
Description: ISPB (Brazilian Payments System) ID for the Pix user receiving the infraction
Type: string
Max length: 8
Example:
99999011

debited_participant required

Title: Debited participant
Description: ISPB (Brazilian Payments System) ID for the Pix user paying the infraction
Type: string
Max length: 8
Example:
99999010

infracting_account_data required

Type: object

account_number required

Title: Account Number
Description: Account number including digit verifier
Type: string
Example:
00000999

branch

Title: Branch
Description: Branch ID without digit
Type: string or null
Example:
0001

reported_by required

Title: Reported By
Description: Participant who made the infraction report
Type: string
Max length: 20
Must be one of the following:
DEBITED_PARTICIPANT
CREDITED_PARTICIPANT
Example:
DEBITED_PARTICIPANT

tax_id_number required

Title: Tax ID number
Description: Tax ID of the Pix infraction reporter registered with Pix DICT
Type: string
Max length: 14
Example:
44455566677

transaction_date required

Title: Transaction date
Description: Associated Pix transaction datetime. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.
Type: string
Format: date-time
Example:
2020-01-17T10:01:00Z

key

Title: Pix Key
Description: Pix key used in the transaction
Type: string or null
Max length: 77
Example:
[email protected]
12345678987

report_details

Title: Report Details
Description: Details that can help the receiving participant to analyze the suspected violation
Type: string
Max length: 2000

transaction_result

Title: Transaction result
Description: Transaction result status
Type: string or null
Max length: 14
Must be one of the following:
SETTLED
REJECTED_PAYEE
REJECTED_PAYER
Example:
SETTLED

transaction_type

Title: Transaction type
Description: Transaction type: SPI - Central Bank system created transaction, INTERNAL - Pismo created transaction
Type: string
Max length: 8
Must be one of the following:
SPI
INTERNAL
Example:
SPI

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Pix infraction status changed",
    "description": "Pix infraction creation and status change event. The following endpoints generate this event:  <a href='https://developers.pismo.io/pismo-docs/reference/post-v2-pix-infraction-create' >Create infraction report</a>, <a href='https://developers.pismo.io/pismo-docs/reference/post-v2-pix-infraction-close' >Close infraction report</a>, and <a href='https://developers.pismo.io/pismo-docs/reference/post-v2-pix-infraction-cancel' >Cancel infraction report</a>. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/pix-instant-payments' >Pix instant payments</a> guide. Also see the <a href='https://developers.pismo.io/pismo-docs/docs/pix-payments-data-events' >Pix payments data events</a> guide.",
    "required": [
        "creation_time",
        "credited_participant",
        "debited_participant",
        "infraction_id",
        "infraction_status",
        "infraction_type",
        "last_modified",
        "reported_by",
        "transaction_id"
    ],
    "properties": {
        "creation_time": {
            "type": "string",
            "title": "Creation Time",
            "description": "Pix infraction report creation datetime on the Pismo platform. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
            "format": "date-time",
            "examples": [
                "2021-10-29T11:00:00.000Z"
            ]
        },
        "credited_participant": {
            "type": "string",
            "title": "Credited participant",
            "description": "ISPB (Brazilian Payments System) identifier for the Pix user receiving the infraction",
            "maxLength": 8,
            "examples": [
                "99999011"
            ]
        },
        "debited_participant": {
            "type": "string",
            "title": "Debited participant",
            "description": "ISPB (Brazilian Payments System) identifier for the Pix user paying the infraction",
            "maxLength": 8,
            "examples": [
                "99999010"
            ]
        },
        "infraction_id": {
            "type": "string",
            "title": "Infraction ID",
            "description": "Pismo-generated Pix infraction ID",
            "examples": [
                "91d65e98-97c0-4b0f-b577-73625da1f9fc"
            ]
        },
        "infraction_status": {
            "type": "string",
            "title": "Infraction status",
            "description": "Pix infraction current status",
            "maxLength": 15,
            "enum": [
                "OPEN",
                "ACKNOWLEDGED",
                "CLOSED",
                "CANCELLED"
            ],
            "examples": [
                "OPEN"
            ]
        },
        "infraction_type": {
            "type": "string",
            "title": "Infraction type",
            "description": "Pix infraction type",
            "maxLength": 16,
            "enum": [
                "FRAUD",
                "REFUND_REQUEST",
                "REFUND_CANCELLED"
            ],
            "examples": [
                "FRAUD"
            ]
        },
        "last_modified": {
            "type": "string",
            "title": "Last Modified",
            "description": "Datetime of most recent infraction report modification. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'.",
            "format": "date-time",
            "examples": [
                "2021-10-29T11:00:00.000Z"
            ]
        },
        "reported_by": {
            "type": "string",
            "title": "Reported By",
            "description": "Participant who originated the infraction report.",
            "maxLength": 20,
            "enum": [
                "DEBITED_PARTICIPANT",
                "CREDITED_PARTICIPANT"
            ],
            "examples": [
                "CREDITED_PARTICIPAMT"
            ]
        },
        "transaction_id": {
            "type": "string",
            "title": "Transaction ID",
            "description": "Pix transaction ID",
            "examples": [
                "E9999901012341234123412345678900"
            ]
        },
        "analysis_result": {
            "type": [
                "string",
                "null"
            ],
            "title": "Analysis Result",
            "description": "Infraction analysis result",
            "enum": [
                "AGREED",
                "DISAGREED"
            ],
            "examples": [
                "AGREED"
            ]
        },
        "analysis_details": {
            "type": [
                "string",
                "null"
            ],
            "title": "Analysis details",
            "description": "Details supporting the infraction analysis result",
            "maxLength": 2000
        },
        "infraction_data": {
            "type": "object",
            "required": [
                "credited_participant",
                "debited_participant",
                "infracting_account_data",
                "reported_by",
                "tax_id_number",
                "transaction_date"
            ],
            "properties": {
                "credited_participant": {
                    "type": "string",
                    "title": "Credited participant",
                    "description": "ISPB (Brazilian Payments System) ID for the Pix user receiving the infraction",
                    "maxLength": 8,
                    "examples": [
                        "99999011"
                    ]
                },
                "debited_participant": {
                    "type": "string",
                    "title": "Debited participant",
                    "description": "ISPB (Brazilian Payments System) ID for the Pix user paying the infraction",
                    "maxLength": 8,
                    "examples": [
                        "99999010"
                    ]
                },
                "infracting_account_data": {
                    "type": "object",
                    "required": [
                        "account_number"
                    ],
                    "properties": {
                        "account_number": {
                            "type": "string",
                            "title": "Account Number",
                            "description": "Account number including digit verifier",
                            "examples": [
                                "00000999"
                            ]
                        },
                        "branch": {
                            "type": [
                                "string",
                                "null"
                            ],
                            "title": "Branch",
                            "description": "Branch ID without digit",
                            "examples": [
                                "0001"
                            ]
                        }
                    }
                },
                "reported_by": {
                    "type": "string",
                    "title": "Reported By",
                    "description": "Participant who made the infraction report",
                    "maxLength": 20,
                    "enum": [
                        "DEBITED_PARTICIPANT",
                        "CREDITED_PARTICIPANT"
                    ],
                    "examples": [
                        "DEBITED_PARTICIPANT"
                    ]
                },
                "tax_id_number": {
                    "type": "string",
                    "title": "Tax ID number",
                    "description": "Tax ID of the Pix infraction reporter registered with Pix DICT",
                    "maxLength": 14,
                    "examples": [
                        "44455566677"
                    ]
                },
                "transaction_date": {
                    "type": "string",
                    "title": "Transaction date",
                    "description": "Associated Pix transaction datetime. A RFC 3339 date-time value, i.e., '2023-04-12T23:20:50.52Z'. ",
                    "format": "date-time",
                    "examples": [
                        "2020-01-17T10:01:00Z"
                    ]
                },
                "key": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Pix Key",
                    "description": "Pix key used in the transaction",
                    "maxLength": 77,
                    "examples": [
                        "[email protected]",
                        "12345678987"
                    ]
                }
            }
        },
        "report_details": {
            "type": "string",
            "title": "Report Details",
            "description": "Details that can help the receiving participant to analyze the suspected violation",
            "maxLength": 2000,
            "examples": []
        },
        "transaction_result": {
            "type": [
                "string",
                "null"
            ],
            "title": "Transaction result",
            "description": "Transaction result status",
            "maxLength": 14,
            "enum": [
                "SETTLED",
                "REJECTED_PAYEE",
                "REJECTED_PAYER"
            ],
            "examples": [
                "SETTLED"
            ]
        },
        "transaction_type": {
            "type": "string",
            "title": "Transaction type",
            "description": "Transaction type: `SPI` - Central Bank system created transaction, `INTERNAL` - Pismo created transaction",
            "maxLength": 8,
            "enum": [
                "SPI",
                "INTERNAL"
            ],
            "examples": [
                "SPI"
            ]
        }
    }
}