Card added to embossing queue

This event - putting a card in the embossing queue - occurs after a card has been created. Depending on schedules, cards in the queue are processed and added (or rejected) to the file sent to an embosser. For a nominal card to be added, the password must have been updated. See the Physical card embossing guide for more information.

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

|
card_id required

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

account_id

Title: Account ID
Description: User's Pismo account ID. Field is empty if errors occur.
Type: integer
Example:
112945011

customer_id

Title: Customer ID
Description: User's Pismo customer ID. Field is empty if errors occur.
Type: integer
Example:
11167891

error_message

Title: Error message.
Description: Error message when a card fails to go to embossing service
Type: string or null
Example:
Card 12345 doesn't have any elected config on embossing service

error_type

Title: Error type
Description: Error type when a card is removed from embossing. This field exists only in case of failure.
Type: string or null
Example:
account_not_found
account_address_not_found
account_address_inactive
account_phone_not_found
customer_not_found
card_pci_not_found
card_pci_password_unchanged
card_not_found
card_status_invalid
card_type_invalid
internal_error
embossing_line_not_formatted
embossing_line_not_encrypted
embossing_line_invalid_format
embossing_undelivered

program_id

Title: Program ID
Description: Pismo program ID
Type: integer
Example:
8765

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Card added to embossing queue",
    "description": "This event - putting a card in the embossing queue - occurs after a card has been created.  Depending on schedules, cards in the queue are processed and added (or rejected) to the file sent to an embosser. For a nominal card to be added, the password must have been updated.  See the <a href='https://developers.pismo.io/pismo-docs/docs/physical-card-embossing' target='_blank'>Physical card embossing</a> guide for more information.",
    "examples": [
        {
            "account_id": 8675309,
            "card_id": 17178724,
            "customer_id": 112131683,
            "error_message": "",
            "error_type": "",
            "program_id": 1226
        }
    ],
    "required": [
        "card_id"
    ],
    "properties": {
        "card_id": {
            "type": "integer",
            "title": "Card ID",
            "description": "Pismo card ID",
            "examples": [
                12345
            ]
        },
        "account_id": {
            "type": "integer",
            "title": "Account ID",
            "description": "User's Pismo account ID. Field is empty if errors occur.",
            "examples": [
                112945011
            ]
        },
        "customer_id": {
            "type": "integer",
            "title": "Customer ID",
            "description": "User's Pismo customer ID. Field is empty if errors occur.",
            "examples": [
                11167891
            ]
        },
        "error_message": {
            "type": [
                "string",
                "null"
            ],
            "title": "Error message.",
            "description": "Error message when a card fails to go to embossing service",
            "examples": [
                "Card 12345 doesn't have any elected config on embossing service"
            ]
        },
        "error_type": {
            "type": [
                "string",
                "null"
            ],
            "title": "Error type",
            "description": "Error type when a card is removed from embossing. This field exists only in case of failure.",
            "examples": [
                "account_not_found",
                "account_address_not_found",
                "account_address_inactive",
                "account_phone_not_found",
                "customer_not_found",
                "card_pci_not_found",
                "card_pci_password_unchanged",
                "card_not_found",
                "card_status_invalid",
                "card_type_invalid",
                "internal_error",
                "embossing_line_not_formatted",
                "embossing_line_not_encrypted",
                "embossing_line_invalid_format",
                "embossing_undelivered"
            ]
        },
        "program_id": {
            "type": "integer",
            "title": "Program ID",
            "description": "Pismo program ID",
            "examples": [
                8765
            ]
        }
    },
    "definitions": {}
}