Adyen · Schema

TransactionRuleInterval

PaymentsFinancial ServicesFintech

Properties

Name Type Description
dayOfMonth integer The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month.
dayOfWeek string The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**. Possible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**,
duration object The duration, which you can specify in hours, days, weeks, or months. The maximum duration is 90 days or an equivalent in other units. Required when the `type` is **rolling** or **sliding**.
timeOfDay string The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**.
timeZone string The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**.
type string The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset. Possible values: * **perTra
View JSON Schema on GitHub

JSON Schema

adyen-transactionruleinterval-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TransactionRuleInterval",
  "title": "TransactionRuleInterval",
  "properties": {
    "dayOfMonth": {
      "x-addedInVersion": "2",
      "description": "The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month.",
      "format": "int32",
      "type": "integer"
    },
    "dayOfWeek": {
      "x-addedInVersion": "2",
      "description": "The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**.\n\nPossible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**, **friday**.",
      "enum": [
        "friday",
        "monday",
        "saturday",
        "sunday",
        "thursday",
        "tuesday",
        "wednesday"
      ],
      "type": "string"
    },
    "duration": {
      "x-addedInVersion": "2",
      "description": "The duration, which you can specify in hours, days, weeks, or months. The maximum duration is 90 days or an equivalent in other units. Required when the `type` is **rolling** or **sliding**.",
      "$ref": "#/components/schemas/Duration"
    },
    "timeOfDay": {
      "x-addedInVersion": "2",
      "description": "The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**.",
      "type": "string"
    },
    "timeZone": {
      "x-addedInVersion": "2",
      "description": "The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**.",
      "type": "string"
    },
    "type": {
      "description": "The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset.\n\nPossible values:\n  * **perTransaction**: conditions are evaluated and the counters are reset for every transaction.\n * **daily**: the counters are reset daily at 00:00:00 UTC.\n * **weekly**: the counters are reset every Monday at 00:00:00 UTC. \n * **monthly**: the counters reset every first day of the month at 00:00:00 UTC. \n * **lifetime**: conditions are applied to the lifetime of the payment instrument.\n * **rolling**: conditions are applied and the counters are reset based on a `duration`. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals.\nFor example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 UTC.\n * **sliding**: conditions are applied and the counters are reset based on the current time and a `duration` that you specify.",
      "enum": [
        "daily",
        "lifetime",
        "monthly",
        "perTransaction",
        "rolling",
        "sliding",
        "weekly"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}