Pix infraction registration failure

Pix infraction integrity registration failure. The following endpoints generate this event: Create 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_registration_failure
Version: 1

|
idempotency_key required

Title: Idempotency key
Description: Key used to guarantee data Idempotency.
Type: string
Max length: 32
Example:
4140f714-04da-42f4-831e-f46b452f36f2

transaction_id required

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

reason required

Title: Reason
Description: Reason for opening an infraction report.
Type: string
Max length: 16
Must be one of the following:
REFUND_REQUEST
REFUND_CANCELLED
Example:
REFUND_REQUEST

situation_type required

Title: Situation type
Description: Situation that gave rise to the infraction notification. For notifications created in api v1, the value UNKNOWN appears.
Type: string
Max length: 16
Must be one of the following:
SCAM
ACCOUNT_TAKEOVER
COERCION
FRAUDULENT_ACCESS
OTHER
UNKNOWN
Example:
SCAM

details

Title: Report Details
Description: Details that may help the counterparty payment service provider (PSP) to analysis the infraction.
Type: string
Max length: 2000

error_message

Title: Error message.
Description: Error message that occurred during processing in the integrity stream.
Type: string
Example:
Error on provider

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "title": "Pix infraction registration failure",
    "description": "Pix infraction integrity registration failure. The following endpoints generate this event:  <a href='https://developers.pismo.io/pismo-docs/reference/post-v2-pix-infraction-create'>Create 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": [
        "idempotency_key",
        "transaction_id",
        "reason",
        "situation_type"
    ],
    "properties": {
        "idempotency_key": {
            "type": "string",
            "title": "Idempotency key",
            "description": "Key used to guarantee data Idempotency.",
            "maxLength": 32,
            "examples": [
                "4140f714-04da-42f4-831e-f46b452f36f2"
            ]
        },
        "transaction_id": {
            "type": "string",
            "title": "Transaction ID",
            "description": "Pix transaction ID",
            "examples": [
                "E9999901012341234123412345678900"
            ]
        },
        "reason": {
            "type": "string",
            "title": "Reason",
            "description": "Reason for opening an infraction report.",
            "maxLength": 16,
            "enum": [
                "REFUND_REQUEST",
                "REFUND_CANCELLED"
            ],
            "example": "REFUND_REQUEST"
        },
        "situation_type": {
            "type": "string",
            "title": "Situation type",
            "description": "Situation that gave rise to the infraction notification. For notifications created in api v1, the value `UNKNOWN` appears.",
            "maxLength": 16,
            "enum": [
                "SCAM",
                "ACCOUNT_TAKEOVER",
                "COERCION",
                "FRAUDULENT_ACCESS",
                "OTHER",
                "UNKNOWN"
            ],
            "example": "SCAM"
        },
        "details": {
            "type": "string",
            "title": "Report Details",
            "description": "Details that may help the counterparty payment service provider (PSP) to analysis the infraction.",
            "maxLength": 2000,
            "examples": []
        },
        "error_message": {
            "type": "string",
            "title": "Error message.",
            "description": "Error message that occurred during processing in the integrity stream.",
            "examples": [
                "Error on provider"
            ]
        }
    }
}