Merchant migration completed

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

Type: object
Additional properties: false
Domain: migration
Event: merchant_outgoing
Version: 1

operation required

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

status required

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

code required

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

message required

Title: The message schema
Description: Message of merchants migration result
Type: string
Example:
Merchants migrated with success

migration required

Title: Migration Identifiers Object
Description: Identifier sent on start of migration process
Type: object
Example:
{
    "id": "migration-id",
    "version_date": "2021-08-11T11:25:00.000Z"
}
id required

Title: Migration Identifier
Type: string
Example:
migration-id

version_date required

Title: Version Date of Migration Identifier
Type: string
Example:
2021-08-11T11:25:00.000Z

entity

Title: Pismo generated merchants information
Type: object
Additional properties: false
Example:
{
    "merchant_id": "12321",
    "processed_at": "2023-07-07T19:55:49.294Z"
}
merchant_id required

Title: Merchant Id
Description: Merchant Id
Type: integer
Example:
39093

processed_at required

Title: Processing date
Description: Processing date
Type: string
Example:
2023-07-07T19:55:49.294Z

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "https://pismo.io/events/migration/merchants_outgoing-1.json",
    "type": "object",
    "title": "Merchant migration completed",
    "description": "Event generated when an merchants migration finishes and the result is reported. Result can be either `SUCCESS` or `FAIL`.",
    "examples": [
        {
            "operation": "CREATION",
            "status": "SUCCESS",
            "code": "MIGR-0001",
            "message": "Merchants migrated with success",
            "migration": {
                "id": "5165",
                "version_date": "2023-05-30T16:22:29.000Z"
            },
            "entity": {
                "processed_at": "2023-07-07T19:55:49.294Z",
                "merchant_id": 39094
            }
        }
    ],
    "required": [
        "operation",
        "status",
        "code",
        "message",
        "migration"
    ],
    "properties": {
        "operation": {
            "$id": "#/properties/operation",
            "type": "string",
            "title": "Migration Operation",
            "description": "If the Merchants migration is a creation or update",
            "enum": [
                "CREATION",
                "UPDATE"
            ],
            "examples": [
                "UPDATE"
            ]
        },
        "status": {
            "$id": "#/properties/status",
            "type": "string",
            "title": "Migration status",
            "description": "If the result of account migration was success or not",
            "enum": [
                "SUCCESS",
                "FAIL"
            ],
            "examples": [
                "SUCCESS",
                "FAIL"
            ]
        },
        "code": {
            "$id": "#/properties/code",
            "type": "string",
            "title": "Migration message code",
            "description": "The code of message for systems",
            "default": "",
            "examples": [
                "MIGR-0001"
            ]
        },
        "message": {
            "$id": "#/properties/message",
            "type": "string",
            "title": "The message schema",
            "description": "Message of merchants migration result",
            "default": "",
            "examples": [
                "Merchants migrated with success"
            ]
        },
        "migration": {
            "$id": "#/properties/migration",
            "type": "object",
            "title": "Migration Identifiers Object",
            "description": "Identifier sent on start of migration process",
            "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",
                    "title": "Migration Identifier",
                    "examples": [
                        "migration-id"
                    ]
                },
                "version_date": {
                    "$id": "#/properties/migration/properties/version_date",
                    "type": "string",
                    "title": "Version Date of Migration Identifier",
                    "examples": [
                        "2021-08-11T11:25:00.000Z"
                    ]
                }
            }
        },
        "entity": {
            "$id": "#/properties/entity",
            "type": "object",
            "title": "Pismo generated merchants information",
            "examples": [
                {
                    "merchant_id": "12321",
                    "processed_at": "2023-07-07T19:55:49.294Z"
                }
            ],
            "required": [
                "merchant_id",
                "processed_at"
            ],
            "properties": {
                "merchant_id": {
                    "$id": "#/properties/entity/properties/merchant_id",
                    "type": "integer",
                    "title": "Merchant Id",
                    "description": "Merchant Id",
                    "examples": [
                        39093
                    ]
                },
                "processed_at": {
                    "$id": "#/properties/entity/properties/processed_at",
                    "type": "string",
                    "title": "Processing date",
                    "description": "Processing date",
                    "examples": [
                        "2023-07-07T19:55:49.294Z"
                    ]
                }
            },
            "additionalProperties": false
        }
    },
    "additionalProperties": false
}

{
    "operation": "CREATION",
    "status": "SUCCESS",
    "code": "MIGR-0001",
    "message": "Merchants migrated with success",
    "migration": {
        "id": "5165",
        "version_date": "2023-05-30T16:22:29.000Z"
    },
    "entity": {
        "processed_at": "2023-07-07T19:55:49.294Z",
        "merchant_id": 39094
    }
}

Updated 3 days ago