Lithic · Schema

Hold Event

Event representing a lifecycle change to a hold

FinTechBaaSCard IssuingPaymentsEmbedded Finance

Properties

Name	Type	Description
token	string
type	object
result	object
detailed_results	array
amount	integer	Amount in cents
created	string
memo	stringnull
settling_transaction_token	stringnull	Transaction token of the payment that settled this hold (only populated for HOLD_SETTLED events)

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/hold_event",
  "title": "Hold Event",
  "description": "Event representing a lifecycle change to a hold",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "format": "uuid"
    },
    "type": {
      "$ref": "#/components/schemas/hold_event_type"
    },
    "result": {
      "$ref": "#/components/schemas/transaction_result"
    },
    "detailed_results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/detailed_results"
      }
    },
    "amount": {
      "type": "integer",
      "description": "Amount in cents"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "memo": {
      "type": [
        "string",
        "null"
      ]
    },
    "settling_transaction_token": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "Transaction token of the payment that settled this hold (only populated for HOLD_SETTLED events)"
    }
  },
  "required": [
    "token",
    "type",
    "result",
    "detailed_results",
    "amount",
    "created",
    "memo",
    "settling_transaction_token"
  ]
}