BulletinRule event

This event occurs when a customer creates,changes or gets a BulletinRule in the Protection Bulletin service. For more information about Protection Bulletin, see the Protection Bulletin

Type: object
Domain: disputes
Event: protection_bulletin_rule_event
Version: 1

|
active required

Title: Active
Description: Active=true if enabled for Protection Bulletin Service.
Type: string
Example:
true
false

allowed_status required

Type: array

default_purge_days

Title: Default purge days
Description: Number of days to remove a card of Protection Bulletin into network.
Type: integer or null
Example:
30
10
1

status_network

Title: Status network.
Description: Status equivalent into network and Pismo. This field is required for Mastercard network for example.
Type: string or null
Example:
L
B

status_pismo required

Title: Status Pismo
Description: The Pismo Status for card. See this Card Status
Type: string
Example:
BLOCKED
LOST

brand_type required

Title: Brand Type.
Description: Network brand type enable into Protection Bulletin Service.
Type: string
Must be one of the following:
MASTERCARD
ELO

event_type required

Title: Event type
Description: Event type into api.
Type: string
Must be one of the following:
POST
GET

ica

Title: Ica
Description: Filing Ica required for Mastercard.
Type: string
Example:
12345
null

org_id required

Title: Org Id
Description: Organization/tenant ID.
Type: string
Example:
TN-1234

program_id required

Title: Program Id
Description: Program ID enable into Pismo.
Type: integer
Example:
1234

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/example.json",
    "title": "BulletinRule event",
    "description": "This event occurs when a customer creates,changes or gets a BulletinRule in the Protection Bulletin service. For more information about Protection Bulletin, see the <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-bulletin' target='blank'>Protection Bulletin</a>",
    "type": "object",
    "examples": [
        {
            "active": "true",
            "allowed_status": [
                {
                    "status_pismo": "LOST"
                },
                {
                    "default_purge_days": 30,
                    "status_pismo": "BLOCKED"
                }
            ],
            "brand_type": "ELO",
            "event_type": "POST",
            "org_id": "TN-1234",
            "program_id": 123456
        },
        {
            "active": "true",
            "allowed_status": [
                {
                    "status_pismo": "LOST",
                    "status_network": "L"
                },
                {
                    "status_pismo": "BLOCKED",
                    "status_network": "B",
                    "default_purge_days": 30
                }
            ],
            "brand_type": "MASTERCARD",
            "event_type": "GET",
            "ica": "123456",
            "org_id": "TN-1234",
            "program_id": 123456
        }
    ],
    "properties": {
        "active": {
            "$id": "#/properties/active",
            "type": "string",
            "title": "Active",
            "description": "Active=true if enabled for Protection Bulletin Service.",
            "examples": [
                "true",
                "false"
            ]
        },
        "allowed_status": {
            "$id": "#/properties/allowed_status",
            "type": "array",
            "title": "Allowed Status",
            "description": "Array for status allowed into Protection Bulletin",
            "items": {
                "type": "object",
                "properties": {
                    "default_purge_days": {
                        "title": "Default purge days",
                        "description": "Number of days to remove a card of Protection Bulletin into network.",
                        "type": [
                            "integer",
                            "null"
                        ],
                        "examples": [
                            30,
                            10,
                            1
                        ]
                    },
                    "status_network": {
                        "title": "Status network.",
                        "description": "Status equivalent into network and Pismo. This field is required for Mastercard network for example.",
                        "type": [
                            "string",
                            "null"
                        ],
                        "examples": [
                            "L",
                            "B"
                        ]
                    },
                    "status_pismo": {
                        "title": "Status Pismo",
                        "description": "The Pismo Status for card. See this <a href='https://developers.pismo.io/pismo-docs/reference/put-v1-card-status'>Card Status</a> ",
                        "type": "string",
                        "examples": [
                            "BLOCKED",
                            "LOST"
                        ]
                    }
                },
                "required": [
                    "status_pismo"
                ]
            }
        },
        "brand_type": {
            "$id": "#/properties/brand_type",
            "title": "Brand Type.",
            "description": "Network brand type enable into Protection Bulletin Service.",
            "type": "string",
            "enum": [
                "MASTERCARD",
                "ELO"
            ]
        },
        "event_type": {
            "$id": "#/properties/event_type",
            "title": "Event type",
            "description": "Event type into api.",
            "type": "string",
            "enum": [
                "POST",
                "GET"
            ]
        },
        "ica": {
            "$id": "#/properties/ica",
            "title": "Ica",
            "description": "Filing Ica required for Mastercard.",
            "type": "string",
            "examples": [
                "12345",
                "null"
            ]
        },
        "org_id": {
            "$id": "#/properties/org_id",
            "title": "Org Id",
            "description": "Organization/tenant ID.",
            "type": "string",
            "examples": [
                "TN-1234"
            ]
        },
        "program_id": {
            "$id": "#/properties/program_id",
            "title": "Program Id",
            "description": "Program ID enable into Pismo.",
            "type": "integer",
            "examples": [
                1234
            ]
        }
    },
    "required": [
        "active",
        "allowed_status",
        "brand_type",
        "event_type",
        "org_id",
        "program_id"
    ]
}
{
    "active": "true",
    "allowed_status": [
        {
            "status_pismo": "LOST"
        },
        {
            "default_purge_days": 30,
            "status_pismo": "BLOCKED"
        }
    ],
    "brand_type": "ELO",
    "event_type": "POST",
    "org_id": "TN-1234",
    "program_id": 123456
}