Platform authorization created [beta]

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Platform authorization created [beta]",
    "description": "This event occurs when a platform authorization is created.",
    "additionalProperties": false,
    "required": [
        "authorization_id",
        "category",
        "clearing_type",
        "code",
        "contract_amount",
        "event_datetime",
        "installment_amount",
        "operation",
        "original_authorization_id",
        "original_authorization_datetime",
        "processing_code",
        "principal_amount",
        "response_code",
        "tracking_id",
        "validation_results"
    ],
    "properties": {
        "authorization_id": {
            "type": "integer",
            "description": "Authorization ID.",
            "examples": [
                1164217752,
                2114217752,
                2964217752
            ]
        },
        "category": {
            "type": "string",
            "description": "Category of the authorization.",
            "enum": [
                "AUTHORIZATION",
                "CANCELLATION",
                "PARTIAL_CANCELLATION",
                "DENIED",
                "DENIED_CANCELLATION",
                "CONFIRMATION"
            ]
        },
        "clearing_type": {
            "type": "string",
            "description": "Type of clearing used for this authorization. Online for authorizations that create instant transactions, offline for authorizations that create transactions from confirmation.",
            "enum": [
                "ONLINE",
                "OFFLINE"
            ]
        },
        "code": {
            "type": "string",
            "description": "Alphanumeric 6-digit ID for the new authorization.",
            "examples": [
                "143ABC",
                "11D5A6",
                "EW15D3"
            ]
        },
        "contract_amount": {
            "type": "number",
            "description": "Calculated authorization amount with taxes or fees in the account's currency.",
            "examples": [
                125.0
            ]
        },
        "event_datetime": {
            "type": "string",
            "description": "Event timestamp in the UTC format (RFC 3339).",
            "format": "date-time",
            "examples": [
                "2023-01-01T00:00:00.000Z"
            ]
        },
        "operation": {
            "type": "string",
            "description": "Operation type of the authorization.",
            "enum": [
                "CASH_IN",
                "CASH_OUT"
            ]
        },
        "original_authorization_id": {
            "type": [
                "integer",
                "null"
            ],
            "description": "Unique ID that represents the original authorization. For events with the AUTHORIZATION category, this field will always have the same value as `authorization_id`.",
            "examples": [
                164217752,
                2214314710,
                2521269102
            ]
        },
        "processing_code": {
            "type": "string",
            "description": "Processing code provided for the authorization.",
            "examples": [
                "007700",
                "009900",
                "007200"
            ]
        },
        "principal_amount": {
            "type": "number",
            "description": "Calculated amount of the authorization without taxes or fees in the account's currency.",
            "examples": [
                100.0
            ]
        },
        "response_code": {
            "type": "string",
            "description": "Response code assigned to the new authorization. Indicates successful authorization or reasons for authorization denial.",
            "examples": [
                "00",
                "55",
                "99"
            ]
        },
        "tracking_id": {
            "type": "string",
            "description": "Unique tracking ID provided by the client for the new authorization.",
            "examples": [
                "9cd6485a-5680-4df0-a1f1-507e21d3428c"
            ]
        },
        "validation_results": {
            "type": "array",
            "description": "All executed validations with details for each result.",
            "items": {
                "$ref": "#/definitions/validation_result"
            }
        },
        "account_currency": {
            "type": "string",
            "description": "ISO-4217 alphabetic code of the account's currency of the authorization.",
            "examples": [
                "USD",
                "BRL",
                "GBP"
            ]
        },
        "account_id": {
            "type": "integer",
            "description": "Unique ID for the account associated with the authorization.",
            "examples": [
                123,
                456,
                789
            ]
        },
        "beneficiary_id": {
            "type": "string",
            "description": "Identifier for the beneficiary related to the account.",
            "examples": [
                "18bfa09c-2216-43f7-97c9-075051c38683",
                "3903367a-23d4-47aa-9d56-3cf9e9890b6c"
            ]
        },
        "caller": {
            "type": "string",
            "description": "Identification of the caller from which the request was originated.",
            "examples": [
                "ON-US",
                "OFF-US",
                "INSTANT-PAY"
            ]
        },
        "cancellation_reason": {
            "type": "string",
            "description": "Reason for the cancellation. Currently, the only supported value is AUTHORIZATION CONFIRMATION TIMEOUT.",
            "enum": [
                "AUTHORIZATION CONFIRMATION TIMEOUT"
            ]
        },
        "card_id": {
            "type": "integer",
            "description": "Unique ID for the card associated with the authorization.",
            "examples": [
                10222,
                8899
            ]
        },
        "customer_id": {
            "type": "integer",
            "description": "Unique ID of the customer associated with the account.",
            "examples": [
                82123,
                98991
            ]
        },
        "denial_code": {
            "description": "Code generated for denied authorizations, which indicates the reason the request was denied.",
            "type": "string",
            "examples": [
                "AU001",
                "AU002",
                "PA001",
                "PA002",
                "IAD",
                "ECE"
            ]
        },
        "description": {
            "type": "string",
            "description": "Description provided for the authorization.",
            "examples": [
                "Cash-in",
                "Cash-out"
            ]
        },
        "entry_mode": {
            "type": "string",
            "description": "Entry mode of the authorization.",
            "examples": [
                "01",
                "05",
                "10"
            ]
        },
        "installment_amount": {
            "type": "number",
            "description": "Installment amount of the authorization. If the authorization does not have more than one installment, the value of this field is the same as `principal_amount`.",
            "examples": [
                50.0
            ]
        },
        "installments_details": {
            "type": "array",
            "description": "Detailed information for all the installments of the authorization.",
            "items": {
                "$ref": "#/definitions/installment_detail"
            }
        },
        "ledger_id": {
            "type": "string",
            "description": "Unique ID of the ledger indicating the account limit impact. This field may be empty since some authorizations don't have any financial impact.",
            "examples": [
                "1585f434-de83-43fc-9840-ad2a61ae13e2"
            ]
        },
        "ledger_impact": {
            "type": "array",
            "description": "Limits that were impacted by the ledger during the authorization.",
            "items": {
                "type": "string",
                "minLength": 1,
                "maxLength": 255
            },
            "examples": [
                "[AvailableCreditLimit]",
                "[AvailableCreditLimit,AvailableSavingsAccountLimit]",
                "[OverdraftLimit]"
            ]
        },
        "ledger_update_datetime": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time of the exact moment of impact on ledger in UTC-0 (RFC3339) format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ). This field may be empty since some authorizations don't have any financial impact.",
            "examples": [
                "2023-01-01T00:00:00.000Z"
            ]
        },
        "local_amount": {
            "type": "number",
            "description": "Local amount of the authorization.",
            "examples": [
                50.0
            ]
        },
        "local_currency": {
            "type": "string",
            "description": "ISO-4217 alphabetic code of the local currency of the authorization.",
            "examples": [
                "USD",
                "BRL",
                "GBP"
            ]
        },
        "marketplace_id": {
            "type": "integer",
            "description": "Unique ID of the marketplace associated with the merchant.",
            "examples": [
                7819,
                9123,
                10231
            ]
        },
        "merchant_id": {
            "type": "integer",
            "description": "Unique ID of the merchant associated with the authorization.",
            "examples": [
                4023,
                6242,
                8231
            ]
        },
        "metadata": {
            "type": "object",
            "title": "Any additional information relevant to the caller.",
            "examples": [
                {
                    "customer-data": {
                        "any": "fields"
                    }
                }
            ],
            "additionalProperties": true
        },
        "number_of_installments": {
            "type": "integer",
            "description": "Number of installments in the authorization.",
            "examples": [
                1,
                6,
                12
            ]
        },
        "nsu": {
            "type": "string",
            "description": "Message initiator ID that uniquely identifies an authorization.",
            "examples": [
                "123456",
                "999000"
            ]
        },
        "original_authorization_confirmed": {
            "type": "boolean",
            "description": "Defines whether the original authorization has been confirmed already.",
            "examples": [
                true,
                false
            ]
        },
        "original_authorization_datetime": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time of the original authorization in UTC-0 (RFC3339) format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ). For events with the AUTHORIZATION category, this field will always have the same value as `event_datetime`.",
            "examples": [
                "2023-01-01T00:00:00.000Z"
            ]
        },
        "org_operation_id": {
            "type": "integer",
            "description": "For Pismo internal processing only.",
            "examples": [
                756,
                913
            ]
        },
        "payment_datetime": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time of the authorized payment in UTC-0 (RFC3339) format, which includes milliseconds (yyyy-MM-ddThh:mm:ss.SSSZ).",
            "examples": [
                "2023-01-01T00:00:00.000Z"
            ]
        },
        "postings": {
            "$ref": "#/definitions/postings"
        },
        "posting_date": {
            "type": "string",
            "description": "Date of the statement when the authorization will be posted. The format is yyyy-mm-dd (RFC 3339).",
            "format": "date",
            "examples": [
                "2023-01-01"
            ]
        },
        "pre_authorization": {
            "description": "Defines whether this authorization request is a pre-authorization or not.",
            "type": "boolean",
            "examples": [
                true,
                false
            ]
        },
        "program_id": {
            "type": "integer",
            "description": "Unique ID for the program associated with the account.",
            "examples": [
                8899,
                10222
            ]
        },
        "rates": {
            "$ref": "#/definitions/rates"
        },
        "raw_message": {
            "type": "object",
            "description": "Metadata provided by applications that integrate with the platform authorization. This field is different from the 'metadata' field, which contains custom information provided by the customer.",
            "examples": [
                {
                    "application-data": {
                        "any": "fields"
                    }
                }
            ]
        },
        "skip_timeline": {
            "type": "boolean",
            "description": "Indicates whether the transaction should skip the generation of an event in the customer's timeline.",
            "examples": [
                true,
                false
            ]
        },
        "statement_id": {
            "type": "integer",
            "description": "Unique ID for the statement when the authorization will be posted.",
            "examples": [
                514312,
                10111
            ]
        },
        "type": {
            "type": "string",
            "description": "Type of the authorization. Indicates if this is a normal authorization, a pre-authorization, a cancellation, or a confirmation.",
            "enum": [
                "NORMAL",
                "PRE_AUTHORIZATION",
                "CANCELLATION",
                "CONFIRMATION"
            ]
        }
    },
    "definitions": {
        "validation_result": {
            "type": "object",
            "description": "Executed validation with details for its result.",
            "additionalProperties": false,
            "required": [
                "name",
                "status",
                "reason",
                "description"
            ],
            "properties": {
                "name": {
                    "description": "Validation name.",
                    "type": "string",
                    "examples": [
                        "PROCESSING_CODE",
                        "FLEX_CONTROLS",
                        "ANTI_FRAUD",
                        "AUTHORIZATION"
                    ]
                },
                "status": {
                    "description": "Validation status.",
                    "type": "string",
                    "enum": [
                        "APPROVED",
                        "REJECTED",
                        "SKIPPED"
                    ]
                },
                "reason": {
                    "description": "Validation reason.",
                    "type": "string",
                    "examples": [
                        "PROCESSING_CODE_NOT_FOUND",
                        "FLEX_CONTROLS_APPROVED",
                        "ANTI_FRAUD_APPROVED",
                        "AUTHORIZATION_ERROR"
                    ]
                },
                "description": {
                    "description": "Validation description.",
                    "type": "string",
                    "examples": [
                        "The processing code was not found.",
                        "The authorization passed flex control evaluation.",
                        "The authorization passed anti-fraud evaluation.",
                        "There was an internal error creating the authorization."
                    ]
                },
                "additional_data": {
                    "title": "Additional data",
                    "description": "Contains additional information that is relevant to identify how the validation was performed. Every type of validation has its own additional data.",
                    "type": [
                        "object",
                        "null"
                    ]
                }
            }
        },
        "postings": {
            "type": "object",
            "description": "Authorization taxes and fees.",
            "additionalProperties": true,
            "examples": [
                {
                    "fee_amount": 1.0,
                    "interest_amount": 5.5
                }
            ]
        },
        "rates": {
            "type": "object",
            "description": "Authorization rates used to calculate taxes and fees present on postings object.",
            "additionalProperties": true,
            "examples": [
                {
                    "conversion_rate": 5.4598,
                    "interest_rate": 10.0
                }
            ]
        },
        "installment_detail": {
            "type": "object",
            "description": "Detailed information for a given installment.",
            "required": [
                "number",
                "installment_amount",
                "principal_amount",
                "postings"
            ],
            "additionalProperties": false,
            "properties": {
                "number": {
                    "type": "integer",
                    "description": "Sequential number of the current installment.",
                    "examples": [
                        1,
                        2
                    ]
                },
                "installment_amount": {
                    "type": "number",
                    "description": "Amount of the current installment.",
                    "examples": [
                        100.5,
                        25.99
                    ]
                },
                "principal_amount": {
                    "type": "number",
                    "description": "Principal amount of the current installment.",
                    "examples": [
                        100.0,
                        25.0
                    ]
                },
                "postings": {
                    "$ref": "#/definitions/postings"
                }
            }
        }
    }
}