Modern Treasury · Schema

event

FintechPaymentsACHWiresTreasury

Properties

Name Type Description
id string
object string
live_mode boolean This field will be true if this object exists in the live environment or false if it exists in the test environment.
created_at string
updated_at string
resource string The type of resource for the event.
event_name string The name of the event.
event_time string The time of the event.
data object The body of the event.
entity_id string The ID of the entity for the event.
View JSON Schema on GitHub

JSON Schema

modern-treasury-event-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/event",
  "title": "event",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "object": {
      "type": "string"
    },
    "live_mode": {
      "type": "boolean",
      "description": "This field will be true if this object exists in the live environment or false if it exists in the test environment."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "resource": {
      "type": "string",
      "description": "The type of resource for the event."
    },
    "event_name": {
      "type": "string",
      "description": "The name of the event."
    },
    "event_time": {
      "type": "string",
      "format": "date-time",
      "description": "The time of the event."
    },
    "data": {
      "type": "object",
      "description": "The body of the event.",
      "additionalProperties": true
    },
    "entity_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the entity for the event."
    }
  },
  "additionalProperties": false,
  "minProperties": 10,
  "required": [
    "id",
    "object",
    "live_mode",
    "created_at",
    "updated_at",
    "resource",
    "event_name",
    "event_time",
    "data",
    "entity_id"
  ]
}