Card migrated

This event is generated when: 1 - Card is migrated, 2 - Card PCI data is migrated, 3 - Card migration is finished

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

account_id required

Title: Account ID
Description: User's Pismo account ID
Type: integer or null
Example:
12345678

card_bin required

Title: Card BIN
Description: Card BIN (bank identifcation number). This field will exist when the PCI data is migrated.
Type: string or null
Example:
599999

card_brand required

Title: Card brand
Description: Card brand - VISA, Mastercard, etc.
Type: string or null
Must be one of the following:
PRIVATE
MASTERCARD
VISA
ELO
RUPAY

card_hash required

Title: Hashed PAN
Description: Hashed PAN (Primary Account Number). This field will exist when the PCI data is migrated.
Type: string or null
Example:
0fsdf0sdf9sdf0sdf0sd0fsdn09vsdj0c9sjdcsdcs0d9c==

card_id required

Title: Card's Pismo ID
Description: Card's Pismo ID.
Type: integer or null
Example:
12345678

card_last_four_numbers required

Title: Last 4 PAN numbers
Description: Last 4 PAN (Primary Account Number) digits. This field will exist when the PCI data is migrated.
Type: string or null
Example:
1234

card_name required

Title: Card's display name
Description: Card's display name
Type: string or null
Example:
Hal Itosis

card_printed_name required

Title: Cardholder's name printed on physical (plastic/metal) card
Description: Printed name for physical (plastic/metal) cards
Type: string or null
Example:
Bea Pawsitive

card_status required

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

card_type required

Title: Card type
Type: string
Must be one of the following:
PLASTIC
VIRTUAL
TEMPORARY
RECURRING - DEPRECATED

expiration_date required

Title: Card expiration date and time
Description: Card expiration date and time formatted as a RFC3339 string.
Type: string or null
Format: date-time
Example:
2025-10-08T00:00:00Z

issuing_date required

Title: Date and time when card issued
Description: Date and time when card issued formatted as a RFC3339 string.
Type: string or null
Format: date-time
Example:
2018-11-13T20:20:39Z

migration required

Type: object

id

Title: Migration ID
Description: Migration ID from card
Type: string or null
Max length: 255
Example:
AE4567987YHL

phase_id

Title: Phase ID
Description: Migration phase ID
Type: string or null
Max length: 64
Example:
phase-01

source

Title: Event source
Type: string or null
Must be one of the following:
PCI
NON-PCI

stage

Title: Stage
Description: Migration stage
Type: string or null
Must be one of the following:
MIGRATING
MIGRATED

version_date

Title: Version date
Description: Card migration version date in RFC3339 format
Type: string or null

program_id required

Title: Card's Pismo program ID
Description: Card's Pismo program ID.
Type: integer or null
Example:
12345678

transaction_limit required

Title: Transaction limit
Description: Transaction limit for VIRTUAL cards
Type: number or null
Example:
10.0

abu_enabled

Title: Automatic Billing Update (ABU) flag
Description: Must card number be sent to Mastercard's Automatic Billing Updater service. Default is true. Mastercard only.
Type: boolean

contactless_enabled

Title: Contactless card flag
Description: Can card make transactions using contactless entry mode. Default is true
Type: boolean

customer_id

Title: Pismo customer ID
Description: Pismo customer ID
Type: integer or null
Example:
100602614

dual_message_debit

Title: Dual message debit card flag
Description: Indicates if card is DMC. Default is false
Type: boolean or null

cvv_next_rotation_date

Title: Date and time for VIRTUAL card Cvv rotation
Description: Date and time for next scheduled card Cvv rotation. Only filled for VIRTUAL card type.
Type: string or null
Format: date-time
Example:
2023-10-09T19:17:13

cvv_rotation_type

Title: Cvv rotation type for VIRTUAL card.
Description: Cvv rotation type for next scheduled card cvv rotation. Only filled for VIRTUAL card type.
Type: string or null
Example:
AUTOMATIC

external_id

Title: Client created information
Description: Customer provided ID for external tracking purposes
Type: string or null
Example:
AFEF234234FSDF

metadata

Title: Metadata
Description: Customer-provided information - no business rule validation is done.
Type: object or null
Example:
{
    "customer-data": {
        "my": "value",
        "my-custom-business-label": "label",
        "score": "123"
    }
}

mode

Title: Card mode
Description: Card mode such as CREDIT
Type: string or null
Example:
CREDIT
DEBIT
COMBO

reissued_card_id

Title: Identification of card at origination.
Type: integer or null
Example:
12345678

template_id

Title: Template ID
Description: Template ID - not null if card migration based on template. Templates are used to implement the BIN override feature. For more information, see the BIN override documentation in the Cards overview guide. To create a template, you need to open a Pismo Service Desk request. The ticket type should be Settings.
Type: string or null
Example:
14a23976-db8c-4f1e-a19c-f0ec79d810r4

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Card migrated",
    "description": "This event is generated when: 1 - Card is migrated, 2 - Card PCI data is migrated, 3 - Card migration is finished",
    "examples": [
        {
            "abu_enabled": true,
            "account_id": 8675309,
            "card_bin": null,
            "card_brand": "MASTERCARD",
            "card_hash": null,
            "card_id": 17388904,
            "card_last_four_numbers": null,
            "card_name": "Vacation card",
            "card_printed_name": "Helen Wheels",
            "card_status": "CREATED",
            "card_type": "VIRTUAL",
            "contactless_enabled": true,
            "customer_id": 100612911,
            "dual_message_debit": null,
            "cvv_next_rotation_date": "2023-10-09T19:17:13",
            "cvv_rotation_type": "AUTOMATIC",
            "expiration_date": "2026-10-15T00:00:00Z",
            "external_id": null,
            "issuing_date": "2021-09-01T13:54:10Z",
            "metadata": null,
            "migration": {
                "id": "migrationId223606",
                "phase_id": "phase-01",
                "source": "NON-PCI",
                "stage": "MIGRATING",
                "version_date": "2022-09-21T18:54:10Z"
            },
            "mode": "CREDIT",
            "program_id": 547,
            "reissued_card_id": null,
            "template_id": "14a23976-db8c-4f1e-a19c-f0ec79d810r4",
            "transaction_limit": 10
        }
    ],
    "required": [
        "account_id",
        "card_bin",
        "card_brand",
        "card_hash",
        "card_id",
        "card_last_four_numbers",
        "card_name",
        "card_printed_name",
        "card_status",
        "card_type",
        "expiration_date",
        "issuing_date",
        "migration",
        "program_id",
        "transaction_limit"
    ],
    "properties": {
        "account_id": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Account ID",
            "description": "User's Pismo account ID",
            "examples": [
                12345678
            ]
        },
        "card_bin": {
            "type": [
                "string",
                "null"
            ],
            "title": "Card BIN",
            "description": "Card BIN (bank identifcation number). This field will exist when the PCI data is migrated.",
            "examples": [
                "599999"
            ]
        },
        "card_brand": {
            "type": [
                "string",
                "null"
            ],
            "title": "Card brand",
            "description": "Card brand - VISA, Mastercard, etc. ",
            "enum": [
                "PRIVATE",
                "MASTERCARD",
                "VISA",
                "ELO",
                "RUPAY"
            ]
        },
        "card_hash": {
            "type": [
                "string",
                "null"
            ],
            "title": "Hashed PAN",
            "description": "Hashed PAN (Primary Account Number).  This field will exist when the PCI data is migrated.",
            "examples": [
                "0fsdf0sdf9sdf0sdf0sd0fsdn09vsdj0c9sjdcsdcs0d9c=="
            ]
        },
        "card_id": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Card's Pismo ID",
            "description": "Card's Pismo ID.",
            "examples": [
                12345678
            ]
        },
        "card_last_four_numbers": {
            "type": [
                "string",
                "null"
            ],
            "title": "Last 4 PAN numbers",
            "description": "Last 4 PAN (Primary Account Number) digits.  This field will exist when the PCI data is migrated.",
            "examples": [
                "1234"
            ]
        },
        "card_name": {
            "type": [
                "string",
                "null"
            ],
            "title": "Card's display name",
            "description": "Card's display name",
            "examples": [
                "Hal Itosis"
            ]
        },
        "card_printed_name": {
            "type": [
                "string",
                "null"
            ],
            "title": "Cardholder's name printed on physical (plastic/metal) card",
            "description": "Printed name for physical (plastic/metal) cards",
            "examples": [
                "Bea Pawsitive"
            ]
        },
        "card_status": {
            "type": "string",
            "title": "Card status",
            "description": "Card's status",
            "enum": [
                "CREATED",
                "UNBOUND",
                "NORMAL",
                "REISSUED",
                "BLOCKED",
                "PENDING",
                "WARNING",
                "LOST",
                "ROBBED",
                "CANCELED",
                "INOPERATIVE",
                "FRAUD",
                "DAMAGED",
                "EXPIRED",
                "DELETED",
                "BROKEN",
                "THEFT",
                "DEFECT"
            ]
        },
        "card_type": {
            "type": "string",
            "title": "Card type",
            "deprecationMessage": "Card types. `RECURRING` is DEPRECATED.",
            "enum": [
                "PLASTIC",
                "VIRTUAL",
                "TEMPORARY",
                "RECURRING - DEPRECATED"
            ]
        },
        "expiration_date": {
            "type": [
                "string",
                "null"
            ],
            "title": "Card expiration date and time",
            "description": "Card expiration date and time formatted as a RFC3339 string. ",
            "format": "date-time",
            "examples": [
                "2025-10-08T00:00:00Z"
            ]
        },
        "issuing_date": {
            "type": [
                "string",
                "null"
            ],
            "title": "Date and time when card issued",
            "description": "Date and time when card issued formatted as a RFC3339 string.",
            "format": "date-time",
            "examples": [
                "2018-11-13T20:20:39Z"
            ]
        },
        "migration": {
            "type": "object",
            "properties": {
                "id": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Migration ID",
                    "description": "Migration ID from card",
                    "maxLength": 255,
                    "examples": [
                        "AE4567987YHL"
                    ]
                },
                "phase_id": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Phase ID",
                    "description": "Migration phase ID",
                    "maxLength": 64,
                    "examples": [
                        "phase-01"
                    ]
                },
                "source": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Event source",
                    "enum": [
                        "PCI",
                        "NON-PCI"
                    ]
                },
                "stage": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Stage",
                    "description": "Migration stage",
                    "enum": [
                        "MIGRATING",
                        "MIGRATED"
                    ]
                },
                "version_date": {
                    "type": [
                        "string",
                        "null"
                    ],
                    "title": "Version date",
                    "description": "Card migration version date in RFC3339 format"
                }
            }
        },
        "program_id": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Card's Pismo program ID",
            "description": "Card's Pismo program ID.",
            "default": 0,
            "examples": [
                12345678
            ]
        },
        "transaction_limit": {
            "type": [
                "number",
                "null"
            ],
            "title": "Transaction limit",
            "description": "Transaction limit for VIRTUAL cards",
            "examples": [
                10.0
            ]
        },
        "abu_enabled": {
            "type": [
                "boolean"
            ],
            "title": "Automatic Billing Update (ABU) flag",
            "description": "Must card number be sent to Mastercard's Automatic Billing Updater service. Default is true. Mastercard only."
        },
        "contactless_enabled": {
            "type": [
                "boolean"
            ],
            "title": "Contactless card flag",
            "description": "Can card make transactions using contactless entry mode. Default is true"
        },
        "customer_id": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Pismo customer ID",
            "description": "Pismo customer ID",
            "examples": [
                100602614
            ]
        },
        "dual_message_debit": {
            "type": [
                "boolean",
                "null"
            ],
            "title": "Dual message debit card flag",
            "description": "Indicates if card is DMC. Default is false"
        },
        "cvv_next_rotation_date": {
            "type": [
                "string",
                "null"
            ],
            "title": "Date and time for VIRTUAL card Cvv rotation",
            "description": "Date and time for next scheduled card Cvv rotation. Only filled for VIRTUAL card type.",
            "format": "date-time",
            "examples": [
                "2023-10-09T19:17:13"
            ]
        },
        "cvv_rotation_type": {
            "type": [
                "string",
                "null"
            ],
            "title": "Cvv rotation type for VIRTUAL card.",
            "description": "Cvv rotation type for next scheduled card cvv rotation. Only filled for `VIRTUAL` card type.",
            "examples": [
                "AUTOMATIC"
            ]
        },
        "external_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "Client created information",
            "description": "Customer provided ID for external tracking purposes",
            "examples": [
                "AFEF234234FSDF"
            ]
        },
        "metadata": {
            "type": [
                "object",
                "null"
            ],
            "title": "Metadata",
            "description": "Customer-provided information - no business rule validation is done.",
            "examples": [
                {
                    "customer-data": {
                        "my": "value",
                        "my-custom-business-label": "label",
                        "score": "123"
                    }
                }
            ]
        },
        "mode": {
            "type": [
                "string",
                "null"
            ],
            "title": "Card mode",
            "description": "Card mode such as `CREDIT`",
            "examples": [
                "CREDIT",
                "DEBIT",
                "COMBO"
            ]
        },
        "reissued_card_id": {
            "type": [
                "integer",
                "null"
            ],
            "title": "Identification of card at origination.",
            "examples": [
                12345678
            ]
        },
        "template_id": {
            "type": [
                "string",
                "null"
            ],
            "title": "Template ID",
            "description": "Template ID - not null if card migration based on template. Templates are used to implement the BIN override feature. For more information, see the <a href='https://developers.pismo.io/pismo-docs/docs/cards-overview-1#bin-override---shared-account-option'>BIN override documentation</a> in the Cards overview guide. To create a template, you need to open a Pismo <a href='https://developers.pismo.io/pismo-docs/docs/service-desk'>Service Desk</a> request. The ticket type should be **Settings**.  ",
            "examples": [
                "14a23976-db8c-4f1e-a19c-f0ec79d810r4"
            ]
        }
    },
    "definitions": {}
}