ABU notification file sent

This event supports Mastercard's Automatic Billing Updater (ABU) feature, which ensures that customer information is up-to-date across multiple sites. This event occurs on a daily basis if any customer billing information has changed - Pismo sends a file of changes to Mastercard. If no changes have taken place, a file is not sent and this event is not generated. For more information, see ABU in the Cards overview guide or Mastercard's Automatic Billing Updater documentation.

Type: object
Domain: cards
Event: automatic_updater
Version: 1

|
account_id required

Title: Account ID
Description: User's Pismo account ID.
Type: integer
Example:
117485993

card_id required

Title: Card ID
Description: Pismo card ID
Type: integer
Example:
12387645

program_id required

Title: Program ID
Description: Card's Pismo program ID
Type: integer
Example:
9965

card_status

Title: Card status
Description: Card's status
Type: string
Must be one of the following:
CREATED
UMBOUND
NORMAL
REISSUED
BLOCKED
PENDING
WARNING
INOPERATIVE
LOST
ROBBED
CANCELED
FRAUD
DAMAGED
EXPIRED
DELETED
BROKEN
THEFT
DEFECT

error_message

Title: Error message.
Description: Error message when ABU fails
Type: string or null
Example:
Unable to connect to network

filename

Title: Automatic updater file name
Description: AU file name if card was sent to the card network
Type: string
Example:
/path/filename.txt

new_card_id

Title: New card ID
Description: New Pismo card ID
Type: integer
Example:
12387645

new_card_status

Title: New card status
Description: New card status
Type: string
Must be one of the following:
CREATED
UMBOUND
NORMAL
REISSUED
BLOCKED
PENDING
WARNING
INOPERATIVE
LOST
ROBBED
CANCELED
FRAUD
DAMAGED
EXPIRED
DELETED
BROKEN
THEFT
DEFECT

reason_code

Title: Automatic updater reason code
Description: Reason for automatic update: N = new account, I = initial load, C = card cancelled, R = replacement when card is reissued, and O = override for deletion.
Type: string or null
Must be one of the following:
N
I
C
R
O

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "ABU notification file sent",
    "description": "This event supports Mastercard's Automatic Billing Updater (ABU) feature, which ensures that customer information is up-to-date across multiple sites.  This event occurs on a daily basis if any customer billing information has changed - Pismo sends a file of changes to Mastercard. If no changes have taken place, a file is not sent and this event is not generated. For more information, see <a href='https://developers.pismo.io/pismo-docs/docs/cards-overview-1#mastercards-automatic-billing-updater-option'>ABU</a> in the Cards overview guide or Mastercard's <a href='https://developer.mastercard.com/product/automatic-billing-updater-abu/'>Automatic Billing Updater</a> documentation.",
    "examples": [
        {
            "account_id": 8675309,
            "customer_id": 0,
            "program_id": 547,
            "card_id": 5561748,
            "card_status": "DELETED",
            "new_card_id": null,
            "new_card_status": "",
            "reason_code": "C",
            "filename": "TN-ddce7e50-0485-49ec-a910-866dff0bfd0f/toMaster/R278/2021/03/20/2021-03-20T00:30:20.txt",
            "error_message": ""
        }
    ],
    "required": [
        "account_id",
        "card_id",
        "program_id"
    ],
    "properties": {
        "account_id": {
            "type": "integer",
            "title": "Account ID",
            "description": "User's Pismo account ID.",
            "examples": [
                117485993
            ]
        },
        "card_id": {
            "type": "integer",
            "title": "Card ID",
            "description": "Pismo card ID",
            "examples": [
                12387645
            ]
        },
        "program_id": {
            "type": "integer",
            "title": "Program ID",
            "description": "Card's Pismo program ID",
            "examples": [
                9965
            ]
        },
        "card_status": {
            "type": "string",
            "title": "Card status",
            "description": "Card's status",
            "enum": [
                "CREATED",
                "UMBOUND",
                "NORMAL",
                "REISSUED",
                "BLOCKED",
                "PENDING",
                "WARNING",
                "INOPERATIVE",
                "LOST",
                "ROBBED",
                "CANCELED",
                "FRAUD",
                "DAMAGED",
                "EXPIRED",
                "DELETED",
                "BROKEN",
                "THEFT",
                "DEFECT"
            ]
        },
        "error_message": {
            "type": [
                "string",
                "null"
            ],
            "title": "Error message.",
            "description": "Error message when ABU fails",
            "examples": [
                "Unable to connect to network"
            ]
        },
        "filename": {
            "type": "string",
            "title": "Automatic updater file name",
            "description": "AU file name if card was sent to the card network",
            "examples": [
                "/path/filename.txt"
            ]
        },
        "new_card_id": {
            "type": "integer",
            "title": "New card ID",
            "description": "New Pismo card ID",
            "examples": [
                12387645
            ]
        },
        "new_card_status": {
            "type": "string",
            "title": "New card status",
            "description": "New card status",
            "enum": [
                "CREATED",
                "UMBOUND",
                "NORMAL",
                "REISSUED",
                "BLOCKED",
                "PENDING",
                "WARNING",
                "INOPERATIVE",
                "LOST",
                "ROBBED",
                "CANCELED",
                "FRAUD",
                "DAMAGED",
                "EXPIRED",
                "DELETED",
                "BROKEN",
                "THEFT",
                "DEFECT"
            ]
        },
        "reason_code": {
            "type": [
                "string",
                "null"
            ],
            "title": "Automatic updater reason code",
            "description": "Reason for automatic update: `N` = new account, `I` = initial load, `C` = card cancelled, `R` = replacement when card is reissued, and `O` = override for deletion.",
            "enum": [
                "N",
                "I",
                "C",
                "R",
                "O"
            ]
        }
    },
    "definitions": {}
}