Bulletin rule created or retrieved

This event occurs when a Protection Bulletin rule is created or retrieved.

The Protection Bulletin is used before a transaction takes place in cases where the issuer is temporarily offline and unable to provide an authorization. In a process known as stand-in, the card network authorizes the transaction to avoid creating problems for the cardholder and merchant. Once the issuer is back online, the card network lets them know what was authorized while they were down.

Type: object
Domain: bulletin
Event: bulletin_rule
Version: 1

|
active required

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

allowed_status required

Type: array

default_purge_days

Title: Default purge configuration
Description: How many days before card is removed from the Protectiion Bulletin.
Type: integer or null
Example:
30
10
1

status_network

Title: Status network.
Description: Network card status equivalent to Pismo card status. For more information, see the status_network field for the Create Protection Bulletin rule endpoint. REQUIRED for Mastercard.
Type: string or null
Example:
L
B

status_pismo required

Title: Pismo card status
Description: Pismo card status. For more information, see Card lifecycle and statuses.
Type: string
Example:
BLOCKED
LOST

brand_type required

Title: Network brand.
Description: Card's network brand.
Type: string
Must be one of the following:
MASTERCARD
ELO

event_type required

Title: API type
Description: REST API type (POST, GET) that generated event.
Type: string
Must be one of the following:
POST
GET

ica

Title: Interbank Card Association (ICA) number
Description: Interbank Card Association (ICA) number - a four-to-six-digit account number that identifies a financial institution or third-party processor operating in the Mastercard network. REQUIRED for Mastercard.
Type: string
Example:
12345
null

org_id required

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

program_id required

Title: Program Id
Description: Pismo program ID
Type: integer
Example:
1234

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/example.json",
    "title": "Bulletin rule created or retrieved",
    "description": "This event occurs when a Protection Bulletin rule is <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-bulletin-setup'>created</a> or <a href='https://developers.pismo.io/pismo-docs/reference/get-v1-bulletin-rule'>retrieved</a>.<br><br>The Protection Bulletin is used before a transaction takes place in cases where the issuer is temporarily offline and unable to provide an authorization. In a process known as <i>stand-in</i>, the card network authorizes the transaction to avoid creating problems for the cardholder and merchant. Once the issuer is back online, the card network lets them know what was authorized while they were down.",
    "type": "object",
    "required": [
        "active",
        "allowed_status",
        "brand_type",
        "event_type",
        "org_id",
        "program_id"
    ],
    "properties": {
        "active": {
            "$id": "#/properties/active",
            "type": "string",
            "title": "Active",
            "description": " `true` = rule enabled for Protection Bulletin.",
            "examples": [
                "true",
                "false"
            ]
        },
        "allowed_status": {
            "$id": "#/properties/allowed_status",
            "type": "array",
            "title": "Allowed status",
            "description": "Protection Bulletin rule statuses and configuration",
            "items": {
                "type": "object",
                "properties": {
                    "default_purge_days": {
                        "title": "Default purge configuration",
                        "description": "How many days before card is removed from the Protectiion Bulletin.",
                        "type": [
                            "integer",
                            "null"
                        ],
                        "examples": [
                            30,
                            10,
                            1
                        ]
                    },
                    "status_network": {
                        "title": "Status network.",
                        "description": "Network card status equivalent to Pismo card status. For more information, see the `status_network` field for the <a href='https://developers.pismo.io/pismo-docs/reference/post-v1-bulletin-setup'>Create Protection Bulletin rule</a> endpoint.  **REQUIRED** for Mastercard.",
                        "type": [
                            "string",
                            "null"
                        ],
                        "examples": [
                            "L",
                            "B"
                        ]
                    },
                    "status_pismo": {
                        "title": "Pismo card status",
                        "description": "Pismo card status. For more information, see  <a href='https://developers.pismo.io/pismo-docs/docs/card-lifecycle-and-statuses'>Card lifecycle and statuses</a>. ",
                        "type": "string",
                        "examples": [
                            "BLOCKED",
                            "LOST"
                        ]
                    }
                },
                "required": [
                    "status_pismo"
                ]
            }
        },
        "brand_type": {
            "$id": "#/properties/brand_type",
            "title": "Network brand.",
            "description": "Card's network brand.",
            "type": "string",
            "enum": [
                "MASTERCARD",
                "ELO"
            ]
        },
        "event_type": {
            "$id": "#/properties/event_type",
            "title": "API type",
            "description": "REST API type (`POST`, `GET`) that generated event.",
            "type": "string",
            "enum": [
                "POST",
                "GET"
            ]
        },
        "ica": {
            "$id": "#/properties/ica",
            "title": "Interbank Card Association (ICA) number",
            "description": "Interbank Card Association (ICA) number - a four-to-six-digit account number that identifies a financial institution or third-party processor operating in the Mastercard network. REQUIRED for Mastercard.",
            "type": "string",
            "examples": [
                "12345",
                "null"
            ]
        },
        "org_id": {
            "$id": "#/properties/org_id",
            "title": "Organization ID",
            "description": "Organization/tenant ID.",
            "type": "string",
            "examples": [
                "TN-1234"
            ]
        },
        "program_id": {
            "$id": "#/properties/program_id",
            "title": "Program Id",
            "description": "Pismo program ID",
            "type": "integer",
            "examples": [
                1234
            ]
        }
    },
    "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
        }
    ]
}
{
    "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
}