On-us authorization migration completed

Event generated when the migration of an on-us authorization migration finishes. Contains the payload with the data to be migrated.

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

code required

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

message required

Description: Message of PCI Card migration result
Type: string
Example:
PCI Card is migrated successfully

migration required

Description: Identifier sent upon starting the migration process
Type: object
Additional properties: false
Example:
{
    "id": "migration-id",
    "version_date": "2021-08-11T11:25:00.000Z",
    "phase_id": "Rollout_Jan2022"
}
id required

Description: Migration identifier
Type: string
Example:
migration-id

version_date required

Description: Version date of migration identifier
Type: string
Format: date-time
Example:
2021-08-11T11:25:00.000Z

status required

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

entity

Description: On-us authorization information generated by Pismo
Type: object
Example:
{
    "authorization_id": 2247799452,
    "tracking_id": "tracking-id",
    "processing_code": "00",
    "account_id": 167406553,
    "authorization_status_id": 2,
    "datetime_utc": "2021-09-13T19:54:41.000",
    "currency": "USD",
    "destination_currency": "BRL",
    "local_amount": 10,
    "principal_amount": 15,
    "contract_amount": 15,
    "card_id": 65287289,
    "merchant_id": 43741,
    "marketplace_id": 1679,
    "authorization_code": "343c8",
    "entry_mode": "01",
    "latitude": "",
    "longitude": "",
    "number_of_installments": 1,
    "authorization_response_code": "00",
    "nsu": "000",
    "network": "VISA",
    "tid": "123",
    "metadata": {
        "key1": "value1",
        "key2": "value2"
    },
    "original_authorization_id": 0,
    "type": "MIGRATION",
    "payment_datetime": "2021-09-13T19:54:41Z",
    "origin": "MIGRATION",
    "validation_results": [],
    "calculated_fees": {},
    "installments_details": [],
    "anti_fraud_metadata": {},
    "rates": {},
    "postings": {},
    "description": "Payment",
    "beneficiary_id": "",
    "installments_plan": "R1CM3D",
    "installment_amount": 0,
    "authorization_denial_code": "EX001"
}
authorization_id required

Description: Authorization identifier generated by Pismo.
Type: integer
Example:
10000012

datetime_utc

Description: This field identifies the date and hour of authorization.
Type: string
Format: date-time
Example:
2022-04-08T17:07:03Z
2022-04-08T17:07:03.500599Z
metadata
Description: This field contains additional authorization information.
Type: object
Additional properties: true
Example:
{
    "RESPONSE_CODE": "62",
    "TERMINAL_CAPABILITY": "0"
}
processing_code

Description: This field identifies the processing code of authorization.
Type: string
Example:
00
01

tracking_id

Description: Unique authorization identifier.
Type: string
Example:
tracking-id-value

number_of_installments

Description: This field identifies the number of installments for authorization.
Type: integer
Example:
1

authorization_response_code

Description: This field identifies the response code of authorization.
Type: string
Example:
00

nsu

Description: This field identifies the Network Settlement Utility (NSU) of the authorization.
Type: string
Example:
6423667

tid

Description: This field identifies the transaction ID of authorization.
Type: string
Example:
transaction_id
1ab8h11

local_amount

Description: This field identifies the local amount of authorization.
Type: number
Example:
15.0

principal_amount

Description: This field identifies the principal amount of authorization.
Type: number
Example:
15.0

contract_amount

Description: This field identifies the contract amount of authorization.
Type: number
Example:
15.0

authorization_status_id

Description: This field identifies the authorization status. It can be one of the following: 1 (TO BE PROCESSED), 2 (PROCESSED), 3 (DENIED), 4 (CANCELED), 6 (CANCEL AUTHORIZATION), 7 (PRE-AUTHORIZATION).
Type: integer
Must be one of the following:
1
2
3
4
6
7
Example:
1
2
3
4
6
7

operation

Title: Migration Operation
Description: Whether the PCI Card migration is a creation or an update
Type: string
Must be one of the following:
CREATION
UPDATE
Example:
UPDATE
CREATION

{
    "$schema": "https://json-schema.org/draft-07/schema",
    "$id": "https://pismo.io/events/migration/on_us_authorization_outgoing-1.json",
    "type": "object",
    "title": "On-us authorization migration completed",
    "description": "Event generated when the migration of an on-us authorization migration finishes. Contains the payload with the data to be migrated.",
    "additionalProperties": true,
    "examples": [
        {
            "operation": "CREATION",
            "status": "SUCCESS",
            "code": "AUTHMIG-0001",
            "message": "Authorization created with success.",
            "entity": {
                "authorization_id": 2247799452,
                "tracking_id": "tracking-id",
                "processing_code": "00",
                "account_id": 167406553,
                "authorization_status_id": 2,
                "datetime_utc": "2021-09-13T19:54:41.000",
                "currency": "USD",
                "destination_currency": "BRL",
                "local_amount": 10,
                "principal_amount": 15,
                "contract_amount": 15,
                "card_id": 65287289,
                "merchant_id": 43741,
                "marketplace_id": 1679,
                "authorization_code": "343c8",
                "entry_mode": "01",
                "latitude": "",
                "longitude": "",
                "number_of_installments": 1,
                "authorization_response_code": "00",
                "nsu": "000",
                "network": "VISA",
                "tid": "123",
                "metadata": {
                    "key1": "value1",
                    "key2": "value2"
                },
                "original_authorization_id": 0,
                "type": "MIGRATION",
                "payment_datetime": "2021-09-13T19:54:41Z",
                "origin": "MIGRATION",
                "validation_results": [],
                "calculated_fees": {},
                "installments_details": [],
                "anti_fraud_metadata": {},
                "rates": {},
                "postings": {},
                "description": "Payment",
                "beneficiary_id": "",
                "installments_plan": "R1CM3D",
                "installment_amount": 0,
                "authorization_denial_code": "EX001"
            },
            "migration": {
                "id": "migration-id",
                "version_date": "2024-04-09T15:54:35Z"
            }
        }
    ],
    "required": [
        "code",
        "message",
        "migration",
        "status"
    ],
    "properties": {
        "code": {
            "$id": "#/properties/code",
            "type": "string",
            "title": "Migration message code",
            "description": "The migration message code for systems",
            "examples": [
                "MIGR-0001"
            ]
        },
        "message": {
            "$id": "#/properties/message",
            "type": "string",
            "description": "Message of PCI Card migration result",
            "examples": [
                "PCI Card is migrated successfully"
            ]
        },
        "migration": {
            "$id": "#/properties/migration",
            "type": "object",
            "description": "Identifier sent upon starting the migration process",
            "examples": [
                {
                    "id": "migration-id",
                    "version_date": "2021-08-11T11:25:00.000Z",
                    "phase_id": "Rollout_Jan2022"
                }
            ],
            "required": [
                "id",
                "version_date"
            ],
            "properties": {
                "id": {
                    "$id": "#/properties/migration/properties/id",
                    "type": "string",
                    "description": "Migration identifier",
                    "examples": [
                        "migration-id"
                    ]
                },
                "version_date": {
                    "$id": "#/properties/migration/properties/version_date",
                    "type": "string",
                    "format": "date-time",
                    "description": "Version date of migration identifier",
                    "examples": [
                        "2021-08-11T11:25:00.000Z"
                    ]
                }
            },
            "additionalProperties": false
        },
        "status": {
            "$id": "#/properties/status",
            "type": "string",
            "title": "Migration status",
            "description": "Whether the result of PCI Card migration was success or not",
            "enum": [
                "SUCCESS",
                "FAIL"
            ],
            "examples": [
                "SUCCESS",
                "FAIL"
            ]
        },
        "entity": {
            "$id": "#/properties/entity",
            "type": "object",
            "description": "On-us authorization information generated by Pismo",
            "examples": [
                {
                    "authorization_id": 2247799452,
                    "tracking_id": "tracking-id",
                    "processing_code": "00",
                    "account_id": 167406553,
                    "authorization_status_id": 2,
                    "datetime_utc": "2021-09-13T19:54:41.000",
                    "currency": "USD",
                    "destination_currency": "BRL",
                    "local_amount": 10,
                    "principal_amount": 15,
                    "contract_amount": 15,
                    "card_id": 65287289,
                    "merchant_id": 43741,
                    "marketplace_id": 1679,
                    "authorization_code": "343c8",
                    "entry_mode": "01",
                    "latitude": "",
                    "longitude": "",
                    "number_of_installments": 1,
                    "authorization_response_code": "00",
                    "nsu": "000",
                    "network": "VISA",
                    "tid": "123",
                    "metadata": {
                        "key1": "value1",
                        "key2": "value2"
                    },
                    "original_authorization_id": 0,
                    "type": "MIGRATION",
                    "payment_datetime": "2021-09-13T19:54:41Z",
                    "origin": "MIGRATION",
                    "validation_results": [],
                    "calculated_fees": {},
                    "installments_details": [],
                    "anti_fraud_metadata": {},
                    "rates": {},
                    "postings": {},
                    "description": "Payment",
                    "beneficiary_id": "",
                    "installments_plan": "R1CM3D",
                    "installment_amount": 0,
                    "authorization_denial_code": "EX001"
                }
            ],
            "required": [
                "authorization_id"
            ],
            "properties": {
                "authorization_id": {
                    "$id": "#/properties/entity/properties/authorization_id",
                    "type": "integer",
                    "description": "Authorization identifier generated by Pismo.",
                    "examples": [
                        10000012
                    ]
                },
                "datetime_utc": {
                    "$id": "#/properties/entity/properties/datetime_utc",
                    "type": "string",
                    "format": "date-time",
                    "description": "This field identifies the date and hour of authorization.",
                    "examples": [
                        "2022-04-08T17:07:03Z",
                        "2022-04-08T17:07:03.500599Z"
                    ]
                },
                "metadata": {
                    "$id": "#/properties/entity/properties/metadata",
                    "type": "object",
                    "description": "This field contains additional authorization information.",
                    "default": {},
                    "additionalProperties": true,
                    "examples": [
                        {
                            "RESPONSE_CODE": "62",
                            "TERMINAL_CAPABILITY": "0"
                        }
                    ]
                },
                "processing_code": {
                    "$id": "#/properties/entity/properties/processing_code",
                    "type": "string",
                    "description": "This field identifies the processing code of authorization.",
                    "examples": [
                        "00",
                        "01"
                    ]
                },
                "tracking_id": {
                    "$id": "#/properties/entity/properties/tracking_id",
                    "type": "string",
                    "description": "Unique authorization identifier.",
                    "examples": [
                        "tracking-id-value"
                    ]
                },
                "number_of_installments": {
                    "$id": "#/properties/data/properties/number_of_installments",
                    "type": "integer",
                    "default": 0,
                    "description": "This field identifies the number of installments for authorization.",
                    "examples": [
                        1
                    ]
                },
                "authorization_response_code": {
                    "$id": "#/properties/data/properties/authorization_response_code",
                    "type": "string",
                    "description": "This field identifies the response code of authorization.",
                    "examples": [
                        "00"
                    ]
                },
                "nsu": {
                    "$id": "#/properties/data/properties/nsu",
                    "type": "string",
                    "description": "This field identifies the Network Settlement Utility (NSU) of the authorization.",
                    "examples": [
                        "6423667"
                    ]
                },
                "tid": {
                    "$id": "#/properties/data/properties/tid",
                    "type": "string",
                    "description": "This field identifies the transaction ID of authorization.",
                    "examples": [
                        "transaction_id",
                        "1ab8h11"
                    ]
                },
                "local_amount": {
                    "$id": "#/properties/data/properties/local_amount",
                    "type": "number",
                    "description": "This field identifies the local amount of authorization.",
                    "examples": [
                        15.0
                    ]
                },
                "principal_amount": {
                    "$id": "#/properties/data/properties/principal_amount",
                    "type": "number",
                    "description": "This field identifies the principal amount of authorization.",
                    "examples": [
                        15.0
                    ]
                },
                "contract_amount": {
                    "$id": "#/properties/data/properties/contract_amount",
                    "type": "number",
                    "description": "This field identifies the contract amount of authorization.",
                    "examples": [
                        15.0
                    ]
                },
                "authorization_status_id": {
                    "$id": "#/properties/data/properties/authorization_status_id",
                    "type": "integer",
                    "description": "This field identifies the authorization status. It can be one of the following: 1 (TO BE PROCESSED), 2 (PROCESSED), 3 (DENIED), 4 (CANCELED), 6 (CANCEL AUTHORIZATION), 7 (PRE-AUTHORIZATION).",
                    "enum": [
                        1,
                        2,
                        3,
                        4,
                        6,
                        7
                    ],
                    "examples": [
                        1,
                        2,
                        3,
                        4,
                        6,
                        7
                    ]
                }
            }
        },
        "operation": {
            "$id": "#/properties/operation",
            "type": "string",
            "title": "Migration Operation",
            "description": "Whether the PCI Card migration is a creation or an update",
            "enum": [
                "CREATION",
                "UPDATE"
            ],
            "examples": [
                "UPDATE",
                "CREATION"
            ]
        },
        "additionalProperties": true
    }
}

Updated 15 days ago