Events timeline

This event occurs when an Event is created.

Type: object
Domain: timeline
Event: events
Version: 1

|
tenant_account_timestamp required

Title: Event ID
Type: string
Example:
TENANT::ACCOUNT::TIMESTAMP

account_id required

Title: User's account ID at Pismo Platform
Type: integer
Example:
12345678

type required

Title: Event type
Type: string
Example:
CONFIRMATION

category required

Title: Event category
Type: string
Example:
AUTHORIZE

timestamp required

Title: Event timestamp
Type: string
Example:
2023-11-01T09:46:48.417790545Z

correlation_id

Title: Event correlation id
Type: string
Example:
4453edca-7cca-11ee-b962-0242ac120002

data required

Title: Event data object
Type: string
Example:
{"item":{"contract_amount": 302.1,"response_code": "57","validation_results": [{ "reason": "CARD_FOUND", "additional_data": {}, "name": "CARD_EXISTS", "description": "Card exists.", "status": "APPROVED"}}}

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "title": "Events timeline",
    "description": "This event occurs when an Event is created.",
    "required": [
        "tenant_account_timestamp",
        "account_id",
        "type",
        "category",
        "timestamp",
        "data"
    ],
    "properties": {
        "tenant_account_timestamp": {
            "type": "string",
            "title": "Event ID",
            "examples": [
                "TENANT::ACCOUNT::TIMESTAMP"
            ]
        },
        "account_id": {
            "type": "integer",
            "title": "User's account ID at Pismo Platform",
            "default": 0,
            "examples": [
                12345678
            ]
        },
        "type": {
            "type": "string",
            "title": "Event type",
            "examples": [
                "CONFIRMATION"
            ]
        },
        "category": {
            "type": "string",
            "title": "Event category",
            "examples": [
                "AUTHORIZE"
            ]
        },
        "timestamp": {
            "type": "string",
            "title": "Event timestamp",
            "examples": [
                "2023-11-01T09:46:48.417790545Z"
            ]
        },
        "correlation_id": {
            "type": "string",
            "title": "Event correlation id",
            "examples": [
                "4453edca-7cca-11ee-b962-0242ac120002"
            ]
        },
        "data": {
            "type": "string",
            "title": "Event data object",
            "examples": [
                "{\"item\":{\"contract_amount\": 302.1,\"response_code\": \"57\",\"validation_results\": [{ \"reason\": \"CARD_FOUND\", \"additional_data\": {}, \"name\": \"CARD_EXISTS\", \"description\": \"Card exists.\",  \"status\": \"APPROVED\"}}}"
            ]
        }
    }
}
{
    "tenant_account_timestamp": "TENANT::ACCOUNT::TIMESTAMP",
    "account_id": 12345678,
    "type": "CONFIRMATION",
    "category": "AUTHORIZE",
    "timestamp": "2023-11-01T09:46:48.417790545Z",
    "correlation_id": "4453edca-7cca-11ee-b962-0242ac120002",
    "data": "{\"item\":{\"contract_amount\": 302.1,\"response_code\": \"57\",\"validation_results\": [{ \"reason\": \"CARD_FOUND\", \"additional_data\": {}, \"name\": \"CARD_EXISTS\", \"description\": \"Card exists.\",  \"status\": \"APPROVED\"}}}"
}