Transaction migration completed

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

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

|
migration required

Title: Migration Identifiers Object
Description: Identifier sent on start of migration process
Type: object
Additional properties: true
Example:

{
    "id": "migration-id",
    "version_date": "2021-08-11T11:25:00.000Z"
}
id required

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

version_date

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

status required

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

message

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

code

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

entity

Title: Pismo generated Transaction information
Type: object
Additional properties: true
Example:

{
    "type": "BILLED",
    "account_id": 127116016,
    "transaction_id": 2743494892,
    "transaction_type_id": 121,
    "authorization_id": 154067523,
    "processing_code": "220041",
    "customer_id": 130125930,
    "statement_id": 258625124,
    "program_id": 2694,
    "card_id": "26019326",
    "network": "VISA",
    "network_transaction_identifier": "tid",
    "card_hash": "2kBr412EhyE822hg5yejIDQfF9PdeFghjn+2AuRBDM8f+ip/UwuRlKDyrCwR2JVtO5JPN77IxPfSaswIvWD6pQ==",
    "card_name": "card",
    "merchant_id": "1",
    "authorization_code": "",
    "authorization_type": "NETWORK",
    "merchant_category_code": "1",
    "clearing_date": "null",
    "accounting_date": "2022-07-27",
    "soft_descriptor": "COMPRA BSA PARCELADA C03/03",
    "settlement_currency_rate": 1,
    "interest_amount": 1,
    "representment": false,
    "is_credit": false,
    "amount": [
        {
            "currency": "BRL",
            "value": 60.0,
            "description": "PRINCIPAL"
        },
        {
            "currency": "BRL",
            "value": 60.0,
            "description": "LOCAL"
        },
        {
            "currency": "BRL",
            "value": 60.0,
            "description": "SETTLEMENT"
        }
    ],
    "installments": [
        {
            "transaction_id": 2716135021,
            "installment": 1,
            "amount": 123.45
        },
        {
            "transaction_id": 2716135023,
            "installment": 2,
            "amount": 234.56
        },
        {
            "transaction_id": 2716135025,
            "installment": 3,
            "amount": 345.68
        }
    ]
}
transaction_id

Description: Transaction's Migration Identifier
Type: integer
Example:
2743494892

type

Description: The Transaction's type. One of (BILLED, TO_BE_BILLED, INSTALLMENTS, ADJUSTMENT)
Type: string
Must be one of the following:
BILLED
TO_BE_BILLED
INSTALLMENTS
Example:
INSTALLMENTS

account_id

Description: Transaction's Account Identifier.
Type: number
Example:
127116016

transaction_type_id

Description: Transaction's type Identifier
Type: number
Example:
122

authorization_id

Description: Transaction's authorization Identifier
Type: number
Example:
3213

processing_code

Description: The Transaction's Processing Code schema
Type: string
Example:
220041

customer_id

Description: The Transaction's customer Identifier
Type: number
Example:
130125930

statement_id

Description: Transaction's Statement Migration Identifier
Type: number
Example:
258625124

program_id

Description: Transaction's Program Identifier
Type: number
Example:
2694

card_id

Description: Transaction's Card Migration Identifier
Type: string
Example:
2908746

network

Description: Transaction's NETWORK
Type: string
Example:
VISA

network_transaction_identifier

Description: Represents the original transaction ID that was provided by the card network. This enables the platform to retrieve the corresponding network authorization during the migration process
Type: string
Example:
tid

card_hash

Description: Card Hash Identifier
Type: string
Example:
2kBr412EhyE822hg5yejIDQfF9PdeFghjn+2AuRBDM8f+ip/

card_name

Description: Transaction's card name
Type: string
Example:
Camps-Card

merchant_id

Description: Transaction's Merchant Identifier
Type: string
Example:
32145

authorization_code

Description: Transaction's authorization code
Type: string
Example:
489721

authorization_type

Description: Transaction's authorization type
Type: string
Must be one of the following:
NETWORK
PLATFORM
ON_US
BANKING
Example:
NETWORK

merchant_category_code

Description: Transaction's Merchant category code
Type: string
Example:
742

clearing_date

Description: Transaction's Clearing Date
Type: string
Format: date
Example:
2023-01-15

accounting_date

Description: Transaction's Merchant Accounting Date
Type: string
Format: date
Example:
2023-01-15

soft_descriptor

Description: Transaction's Soft Descriptor
Type: string
Example:
COMPRA LOJA 13

settlement_currency_rate

Description: Transaction's Settlement Currency Rate
Type: number
Example:
12.55

interest_amount

Description: Transaction's Interest Amount
Type: number
Example:
12.42

representment

Description: Transaction's representment
Type: boolean
Example:
false

is_credit

Description: Transaction's is credit
Type: boolean
Example:
false

amount

Description: Transaction's Amount
Type: array
Example:

[
    {
        "type": "PRINCIPAL",
        "currency": "USD",
        "value": "2.55"
    }
]
description

Description: Transaction's Amount Description
Type: string
Example:
PRINCIPAL

currency

Description: Transaction's Amount Currency
Type: string
Example:
USD

value

Description: Transaction's Amount Value
Type: string
Example:
2.55

installments

Description: Transaction's installments
Type: array
Example:

[
    {
        "transaction_id": 2716135021,
        "installment": 1,
        "amount": 123.45
    }
]
transaction_id

Description: Transaction's Amount Description
Type: integer
Example:
2716135021

installment

Description: Transaction's installment
Type: integer
Example:
2

amount

Description: Transaction's Amount Value
Type: number
Example:
233.22

operation

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

error_details
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "https://pismo.io/events/migration/transaction_outgoing-1.json",
    "type": "object",
    "title": "Transaction migration completed",
    "description": "Event generated when an transaction migration finishes and the result is reported. Result can be either `SUCCESS` or `FAIL`.",
    "examples": [
        {
            "operation": "UPDATE",
            "status": "SUCCESS",
            "code": "MIGR-0001",
            "message": "Transaction migrated with success",
            "migration": {
                "id": "migration-id",
                "version_date": "2021-08-11T11:25:00.000Z"
            },
            "entity": {
                "type": "INSTALLMENTS",
                "account_id": 127116016,
                "transaction_id": 2743494892,
                "transaction_type_id": 121,
                "authorization_id": 154067523,
                "processing_code": "220041",
                "customer_id": 130125930,
                "statement_id": 258625124,
                "program_id": 2694,
                "card_id": "26019326",
                "network": "VISA",
                "network_transaction_identifier": "tid",
                "card_hash": "2kBr412EhyE822hg5yejIDQfF9PdeFghjn+2AuRBDM8f+ip/UwuRlKDyrCwR2JVtO5JPN77IxPfSaswIvWD6pQ==",
                "card_name": "card",
                "merchant_id": "1",
                "authorization_code": "",
                "authorization_type": "NETWORK",
                "merchant_category_code": "1",
                "clearing_date": "null",
                "accounting_date": "2022-07-27",
                "soft_descriptor": "COMPRA BSA PARCELADA C03/03",
                "settlement_currency_rate": 1,
                "interest_amount": 1,
                "representment": false,
                "is_credit": false,
                "amount": [
                    {
                        "currency": "BRL",
                        "value": 60.0,
                        "description": "PRINCIPAL"
                    },
                    {
                        "currency": "BRL",
                        "value": 60.0,
                        "description": "LOCAL"
                    },
                    {
                        "currency": "BRL",
                        "value": 60.0,
                        "description": "SETTLEMENT"
                    }
                ],
                "installments": [
                    {
                        "transaction_id": 2716135021,
                        "installment": 1,
                        "amount": 123.45
                    },
                    {
                        "transaction_id": 2716135023,
                        "installment": 2,
                        "amount": 234.56
                    },
                    {
                        "transaction_id": 2716135025,
                        "installment": 3,
                        "amount": 345.68
                    }
                ]
            },
            "error_details": [
                {
                    "property": "merchant_id",
                    "message": "merchant_id is required"
                }
            ]
        }
    ],
    "required": [
        "migration",
        "status"
    ],
    "properties": {
        "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"
            ],
            "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",
                    "format": "date-time",
                    "title": "Version Date of Migration Identifier",
                    "examples": [
                        "2021-08-11T11:25:00.000Z"
                    ]
                }
            },
            "additionalProperties": true
        },
        "status": {
            "$id": "#/properties/status",
            "type": "string",
            "title": "Migration status",
            "description": "If the result of Transaction migration was success or not",
            "enum": [
                "SUCCESS",
                "FAIL"
            ],
            "examples": [
                "SUCCESS",
                "FAIL"
            ]
        },
        "message": {
            "$id": "#/properties/message",
            "type": "string",
            "title": "The message schema",
            "description": "Message of Transaction migration result",
            "examples": [
                "Transaction migrated with success"
            ]
        },
        "code": {
            "$id": "#/properties/code",
            "type": "string",
            "title": "Migration message code",
            "description": "The code of message for systems",
            "examples": [
                "MIGR-0001"
            ]
        },
        "entity": {
            "$id": "#/properties/entity",
            "type": "object",
            "title": "Pismo generated Transaction information",
            "examples": [
                {
                    "type": "BILLED",
                    "account_id": 127116016,
                    "transaction_id": 2743494892,
                    "transaction_type_id": 121,
                    "authorization_id": 154067523,
                    "processing_code": "220041",
                    "customer_id": 130125930,
                    "statement_id": 258625124,
                    "program_id": 2694,
                    "card_id": "26019326",
                    "network": "VISA",
                    "network_transaction_identifier": "tid",
                    "card_hash": "2kBr412EhyE822hg5yejIDQfF9PdeFghjn+2AuRBDM8f+ip/UwuRlKDyrCwR2JVtO5JPN77IxPfSaswIvWD6pQ==",
                    "card_name": "card",
                    "merchant_id": "1",
                    "authorization_code": "",
                    "authorization_type": "NETWORK",
                    "merchant_category_code": "1",
                    "clearing_date": "null",
                    "accounting_date": "2022-07-27",
                    "soft_descriptor": "COMPRA BSA PARCELADA C03/03",
                    "settlement_currency_rate": 1,
                    "interest_amount": 1,
                    "representment": false,
                    "is_credit": false,
                    "amount": [
                        {
                            "currency": "BRL",
                            "value": 60.0,
                            "description": "PRINCIPAL"
                        },
                        {
                            "currency": "BRL",
                            "value": 60.0,
                            "description": "LOCAL"
                        },
                        {
                            "currency": "BRL",
                            "value": 60.0,
                            "description": "SETTLEMENT"
                        }
                    ],
                    "installments": [
                        {
                            "transaction_id": 2716135021,
                            "installment": 1,
                            "amount": 123.45
                        },
                        {
                            "transaction_id": 2716135023,
                            "installment": 2,
                            "amount": 234.56
                        },
                        {
                            "transaction_id": 2716135025,
                            "installment": 3,
                            "amount": 345.68
                        }
                    ]
                }
            ],
            "properties": {
                "transaction_id": {
                    "$id": "#/properties/entity/properties/transaction_id",
                    "type": "integer",
                    "description": "Transaction's Migration Identifier",
                    "examples": [
                        2743494892
                    ]
                },
                "type": {
                    "$id": "#/properties/entity/properties/type",
                    "type": "string",
                    "description": "The Transaction's type. One of (BILLED, TO_BE_BILLED, INSTALLMENTS, ADJUSTMENT)",
                    "enum": [
                        "BILLED",
                        "TO_BE_BILLED",
                        "INSTALLMENTS"
                    ],
                    "examples": [
                        "INSTALLMENTS"
                    ]
                },
                "account_id": {
                    "$id": "#/properties/entity/properties/account_id",
                    "type": "number",
                    "description": "Transaction's Account Identifier.",
                    "examples": [
                        127116016
                    ]
                },
                "transaction_type_id": {
                    "$id": "#/properties/entity/properties/transaction_type_id",
                    "type": "number",
                    "description": "Transaction's type Identifier",
                    "examples": [
                        122
                    ]
                },
                "authorization_id": {
                    "$id": "#/properties/entity/properties/authorization_id",
                    "type": "number",
                    "description": "Transaction's authorization Identifier",
                    "examples": [
                        3213
                    ]
                },
                "processing_code": {
                    "$id": "#/properties/entity/properties/processing_code",
                    "type": "string",
                    "description": "The Transaction's Processing Code schema",
                    "examples": [
                        "220041"
                    ]
                },
                "customer_id": {
                    "$id": "#/properties/entity/properties/customer_id",
                    "type": "number",
                    "description": "The Transaction's customer Identifier",
                    "examples": [
                        130125930
                    ]
                },
                "statement_id": {
                    "$id": "#/properties/entity/properties/statement_id",
                    "type": "number",
                    "description": "Transaction's Statement Migration Identifier",
                    "examples": [
                        258625124
                    ]
                },
                "program_id": {
                    "$id": "#/properties/entity/properties/program_id",
                    "type": "number",
                    "description": "Transaction's Program Identifier",
                    "examples": [
                        2694
                    ]
                },
                "card_id": {
                    "$id": "#/properties/entity/properties/card_id",
                    "type": "string",
                    "description": "Transaction's Card Migration Identifier",
                    "examples": [
                        "2908746"
                    ]
                },
                "network": {
                    "$id": "#/properties/entity/properties/network",
                    "type": "string",
                    "description": "Transaction's NETWORK",
                    "examples": [
                        "VISA"
                    ]
                },
                "network_transaction_identifier": {
                    "$id": "#/properties/entity/properties/network_transaction_identifier",
                    "type": "string",
                    "description": "Represents the original transaction ID that was provided by the card network. This enables the platform to retrieve the corresponding network authorization during the migration process",
                    "examples": [
                        "tid"
                    ]
                },
                "card_hash": {
                    "$id": "#/properties/entity/properties/card_hash",
                    "type": "string",
                    "description": "Card Hash Identifier",
                    "examples": [
                        "2kBr412EhyE822hg5yejIDQfF9PdeFghjn+2AuRBDM8f+ip/"
                    ]
                },
                "card_name": {
                    "$id": "#/properties/entity/properties/card_name",
                    "type": "string",
                    "description": "Transaction's card name",
                    "examples": [
                        "Camps-Card"
                    ]
                },
                "merchant_id": {
                    "$id": "#/properties/entity/properties/merchant_id",
                    "type": "string",
                    "description": "Transaction's Merchant Identifier",
                    "examples": [
                        "32145"
                    ]
                },
                "authorization_code": {
                    "$id": "#/properties/entity/properties/authorization_code",
                    "type": "string",
                    "description": "Transaction's authorization code",
                    "examples": [
                        "489721"
                    ]
                },
                "authorization_type": {
                    "$id": "#/properties/entity/properties/authorization_code",
                    "type": "string",
                    "description": "Transaction's authorization type",
                    "enum": [
                        "NETWORK",
                        "PLATFORM",
                        "ON_US",
                        "BANKING"
                    ],
                    "examples": [
                        "NETWORK"
                    ]
                },
                "merchant_category_code": {
                    "$id": "#/properties/entity/properties/merchant_category_code",
                    "type": "string",
                    "description": "Transaction's Merchant category code",
                    "examples": [
                        "742"
                    ]
                },
                "clearing_date": {
                    "$id": "#/properties/entity/properties/clearing_date",
                    "type": "string",
                    "description": "Transaction's Clearing Date",
                    "format": "date",
                    "examples": [
                        "2023-01-15"
                    ]
                },
                "accounting_date": {
                    "$id": "#/properties/entity/properties/accounting_date",
                    "type": "string",
                    "description": "Transaction's Merchant Accounting Date",
                    "format": "date",
                    "examples": [
                        "2023-01-15"
                    ]
                },
                "soft_descriptor": {
                    "$id": "#/properties/entity/properties/soft_descriptor",
                    "type": "string",
                    "description": "Transaction's Soft Descriptor",
                    "examples": [
                        "COMPRA LOJA 13"
                    ]
                },
                "settlement_currency_rate": {
                    "$id": "#/properties/entity/properties/settlement_currency_rate",
                    "type": "number",
                    "description": "Transaction's Settlement Currency Rate",
                    "examples": [
                        12.55
                    ]
                },
                "interest_amount": {
                    "$id": "#/properties/entity/properties/interest_amount",
                    "type": "number",
                    "description": "Transaction's Interest Amount",
                    "examples": [
                        12.42
                    ]
                },
                "representment": {
                    "$id": "#/properties/entity/properties/representment",
                    "type": "boolean",
                    "description": "Transaction's representment",
                    "examples": [
                        false
                    ]
                },
                "is_credit": {
                    "$id": "#/properties/entity/properties/is_credit",
                    "type": "boolean",
                    "description": "Transaction's is credit",
                    "examples": [
                        false
                    ]
                },
                "amount": {
                    "$id": "#/properties/entity/properties/amount",
                    "type": "array",
                    "description": "Transaction's Amount",
                    "examples": [
                        [
                            {
                                "type": "PRINCIPAL",
                                "currency": "USD",
                                "value": "2.55"
                            },
                            {
                                "type": "LOCAL",
                                "currency": "USD",
                                "value": "2.5"
                            }
                        ]
                    ],
                    "additionalItems": true,
                    "items": {
                        "type": "object",
                        "description": "Transaction's Amount Object",
                        "examples": [
                            {
                                "type": "PRINCIPAL",
                                "currency": "USD",
                                "value": "2.55"
                            }
                        ],
                        "properties": {
                            "description": {
                                "$id": "#/properties/entity/properties/amount/items/anyOf/0/properties/description",
                                "type": "string",
                                "description": "Transaction's Amount Description",
                                "examples": [
                                    "PRINCIPAL"
                                ]
                            },
                            "currency": {
                                "$id": "#/properties/entity/properties/amount/items/anyOf/0/properties/currency",
                                "type": "string",
                                "description": "Transaction's Amount Currency",
                                "examples": [
                                    "USD"
                                ]
                            },
                            "value": {
                                "$id": "#/properties/entity/properties/amount/items/anyOf/0/properties/value",
                                "type": "string",
                                "description": "Transaction's Amount Value",
                                "examples": [
                                    "2.55"
                                ]
                            }
                        }
                    }
                },
                "installments": {
                    "$id": "#/properties/entity/properties/installments",
                    "type": "array",
                    "description": "Transaction's installments",
                    "examples": [
                        [
                            {
                                "transaction_id": 2716135021,
                                "installment": 1,
                                "amount": 123.45
                            },
                            {
                                "transaction_id": 2716135023,
                                "installment": 2,
                                "amount": 234.56
                            }
                        ]
                    ],
                    "additionalItems": true,
                    "items": {
                        "type": "object",
                        "description": "Transaction's Installments Object",
                        "examples": [
                            {
                                "transaction_id": 2716135021,
                                "installment": 1,
                                "amount": 123.45
                            }
                        ],
                        "properties": {
                            "transaction_id": {
                                "$id": "#/properties/entity/properties/installments/items/anyOf/0/properties/transaction_id",
                                "type": "integer",
                                "description": "Transaction's Amount Description",
                                "examples": [
                                    2716135021
                                ]
                            },
                            "installment": {
                                "$id": "#/properties/entity/properties/installments/items/anyOf/0/properties/installment",
                                "type": "integer",
                                "description": "Transaction's installment",
                                "examples": [
                                    2
                                ]
                            },
                            "amount": {
                                "$id": "#/properties/entity/properties/installments/items/anyOf/0/properties/amount",
                                "type": "number",
                                "description": "Transaction's Amount Value",
                                "examples": [
                                    233.22
                                ]
                            }
                        }
                    }
                },
                "additionalProperties": true
            },
            "additionalProperties": true
        },
        "operation": {
            "$id": "#/properties/operation",
            "type": "string",
            "title": "Migration Operation",
            "description": "If the Transaction migration is a creation or update",
            "enum": [
                "CREATION",
                "UPDATE"
            ],
            "examples": [
                "UPDATE",
                "CREATION"
            ]
        },
        "error_details": {
            "$id": "#/properties/error_details",
            "type": "array",
            "title": "Error Details",
            "description": "A List with error's details",
            "examples": [
                [
                    {
                        "property": "merchant_id",
                        "message": "merchant_id is required"
                    }
                ]
            ],
            "additionalItems": true,
            "items": {
                "$id": "#/properties/error_details/items",
                "anyOf": [
                    {
                        "$id": "#/properties/error_details/items/anyOf/0",
                        "type": "object",
                        "title": "Detail",
                        "examples": [
                            {
                                "property": "merchant_id",
                                "message": "merchant_id is required"
                            }
                        ],
                        "properties": {
                            "property": {
                                "$id": "#/properties/error_details/items/anyOf/0/properties/property",
                                "type": "string",
                                "title": "The property of incomming event",
                                "examples": [
                                    "merchant_id"
                                ]
                            },
                            "message": {
                                "$id": "#/properties/error_details/items/anyOf/0/properties/message",
                                "type": "string",
                                "title": "An Error Message",
                                "examples": [
                                    "merchant_id is required"
                                ]
                            }
                        },
                        "additionalProperties": false
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}