TransactionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-transaction-request-schema.json",
  "title": "TransactionRequest",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-get-notifications-api-openapi.yml#/components/schemas/TransactionRequest",
  "properties": {
    "start": {
      "description": "Specify an end date and time to retrieve notifications generated up to this date from the start date specified.<br>Must be in UTC and formatted according to the ISO 8601.<br>This value is inclusive.<br>Must be in the past.<br>Must be after the start date",
      "type": "string"
    },
    "end": {
      "description": "Specify an end date and time to retrieve notifications generated up to this date from the start date specified.<br>Must be in UTC and formatted according to the ISO 8601.<br>This value is exclusive.<br>Must be in the past.<br>Must be after the start date",
      "type": "string"
    },
    "subscriptionName": {
      "description": "Specify a subscription name to return notifications only for that subscription. Provide multiple values separated by commas.",
      "type": "string",
      "maxLength": 50,
      "minLength": 1
    },
    "eventType": {
      "description": "Client Allowed values are either 1 of the below:<ul><li>PAYMENT_AUTHORIZATION</li><li>CLEARING</li></ul>If not provided default to 'PAYMENT_AUTHORIZATION'",
      "type": "string"
    },
    "offset": {
      "description": "The number of notifications to skip before selecting the notifications to return. The default value is zero, which selects the first subscription.",
      "type": "integer"
    },
    "limit": {
      "description": "A maximum of 100 notifications can be returned in 1 response",
      "type": "integer"
    },
    "pushStatus": {
      "description": "Specify a push status.<br><br>PENDING: The notification is in the process of being delivered.<br><br>DELIVERED: The service has pushed the notification to the push endpointsuccessfully.<br><br>FAILED: The service s attempts to deliver the notification have failed and nofuture deliveries will be performed. The notification is available via the pullapproach until its retention period expires.<br><br>Accepts multiple values separated by comma<br>If not included, notifications with the status at the time of retrieving will be returned.",
      "type": "string"
    }
  },
  "required": [
    "start",
    "end",
    "subscriptionName"
  ]
}