Authorization migration completed

Event generated when an authorization migration finishes and the result is reported. Result can be either SUCCESS or FAIL.

Type: object
Additional properties: true
Domain: migration
Event: authorization_outgoing
Version: 1

code required

Description: The code of message for systems
Type: string
Example:
MIGR-0001

message required

Description: Message of migration result
Type: string
Example:
Authorization migrated with success

migration required

Description: This field contains the data that identifies a migration.
Type: object
Additional properties: false
Example:
{
    "id": "migration-id",
    "version_date": "2021-08-11T11:25:00.000Z"
}
id required

Description: This field is the unique identifier of migration.
Type: string
Example:
migration-id

version_date required

Description: This field is the date of version of migration.
Type: string
Format: date-time
Example:
2021-08-11T11:25:00.000Z

status required

Description: If the result of authorization migration was success or not
Type: string
Must be one of the following:
SUCCESS
FAIL
Example:
SUCCESS
FAIL

entity required

Title: Pismo generated Authorization information
Type: object
Additional properties: true
Example:
{
    "network_authorization_id": 1999,
    "account_id": 4269666,
    "card_id": 555
}
network_authorization_id

Description: Authorization identifier generated by pismo.
Type: integer
Example:
9999

account_id required

Description: Account identifier in pismo plataform.
Type: integer
Example:
4269666

card_id required

Description: Card identifier in pismo plataform.
Type: integer
Example:
555

operation

Description: If the Authorization migration is a creation or update
Type: string
Must be one of the following:
CREATION
UPDATE
Example:
UPDATE
CREATION

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "https://pismo.io/events/migration/authorization_outgoing-1.json",
    "type": "object",
    "additionalProperties": true,
    "title": "Authorization migration completed",
    "description": "Event generated when an authorization migration finishes and the result is reported. Result can be either `SUCCESS` or `FAIL`.",
    "examples": [
        {
            "operation": "CREATION",
            "status": "SUCCESS",
            "code": "MIGR-0001",
            "message": "Authorization has been migrated with success!",
            "migration": {
                "id": "0000001238929602022-03-14",
                "version_date": "2022-03-14T09:38:18Z"
            },
            "entity": {
                "network_authorization_id": 1999,
                "account_id": 4269666,
                "card_id": 555
            }
        },
        {
            "status": "FAIL",
            "code": "001",
            "message": "Authorization not migrated!",
            "migration": {
                "id": "21390232942-authorizations",
                "version_date": "2021-11-27T20:54:41Z"
            }
        }
    ],
    "required": [
        "code",
        "message",
        "migration",
        "status"
    ],
    "properties": {
        "code": {
            "$id": "#/properties/code",
            "type": "string",
            "description": "The code of message for systems",
            "examples": [
                "MIGR-0001"
            ]
        },
        "message": {
            "$id": "#/properties/message",
            "type": "string",
            "description": "Message of migration result",
            "examples": [
                "Authorization migrated with success"
            ]
        },
        "migration": {
            "$id": "#/properties/entity/properties/migration",
            "type": "object",
            "additionalProperties": false,
            "description": "This field contains the data that identifies a migration.",
            "examples": [
                {
                    "id": "migration-id",
                    "version_date": "2021-08-11T11:25:00.000Z"
                }
            ],
            "required": [
                "id",
                "version_date"
            ],
            "properties": {
                "id": {
                    "$id": "#/properties/migration/properties/id",
                    "type": "string",
                    "description": "This field is the unique identifier of migration.",
                    "examples": [
                        "migration-id"
                    ]
                },
                "version_date": {
                    "$id": "#/properties/migration/properties/version_date",
                    "type": "string",
                    "format": "date-time",
                    "description": "This field is the date of version of migration.",
                    "examples": [
                        "2021-08-11T11:25:00.000Z"
                    ]
                }
            }
        },
        "status": {
            "$id": "#/properties/status",
            "type": "string",
            "description": "If the result of authorization migration was success or not",
            "enum": [
                "SUCCESS",
                "FAIL"
            ],
            "examples": [
                "SUCCESS",
                "FAIL"
            ]
        },
        "entity": {
            "$id": "#/properties/entity",
            "type": "object",
            "additionalProperties": true,
            "title": "Pismo generated Authorization information",
            "examples": [
                {
                    "network_authorization_id": 1999,
                    "account_id": 4269666,
                    "card_id": 555
                }
            ],
            "required": [
                "account_id",
                "card_id"
            ],
            "properties": {
                "network_authorization_id": {
                    "$id": "#/properties/entity/properties/network_authorization_id",
                    "type": "integer",
                    "description": "Authorization identifier generated by pismo.",
                    "examples": [
                        9999
                    ]
                },
                "account_id": {
                    "$id": "#/properties/entity/properties/network_authorization_id",
                    "type": "integer",
                    "description": "Account identifier in pismo plataform.",
                    "examples": [
                        4269666
                    ]
                },
                "card_id": {
                    "$id": "#/properties/entity/properties/network_authorization_id",
                    "type": "integer",
                    "description": "Card identifier in pismo plataform.",
                    "examples": [
                        555
                    ]
                }
            }
        },
        "operation": {
            "$id": "#/properties/operation",
            "type": "string",
            "description": "If the Authorization migration is a creation or update",
            "enum": [
                "CREATION",
                "UPDATE"
            ],
            "examples": [
                "UPDATE",
                "CREATION"
            ]
        }
    }
}

{
    "operation": "CREATION",
    "status": "SUCCESS",
    "code": "MIGR-0001",
    "message": "Authorization has been migrated with success!",
    "migration": {
        "id": "0000001238929602022-03-14",
        "version_date": "2022-03-14T09:38:18Z"
    },
    "entity": {
        "network_authorization_id": 1999,
        "account_id": 4269666,
        "card_id": 555
    }
}

Updated 16 days ago