Adyen · JSON Structure

Notification Webhooks Sweep Schedule Structure

SweepSchedule schema from Adyen API

Type: object Properties: 1
PaymentsFinancial ServicesFintech

SweepSchedule is a JSON Structure definition published by Adyen, describing 1 property. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/notification-webhooks-sweep-schedule-structure.json",
  "description": "SweepSchedule schema from Adyen API",
  "properties": {
    "type": {
      "description": "The schedule type.\n\nPossible values:\n\n* **cron**: push out funds based on a cron expression.\n\n* **daily**: push out funds daily at 07:00 AM CET.\n\n* **weekly**: push out funds every Monday at 07:00 AM CET.\n\n* **monthly**: push out funds every first of the month at 07:00 AM CET.\n\n* **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`.",
      "enum": [
        "daily",
        "weekly",
        "monthly",
        "balance",
        "cron"
      ],
      "type": "string"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "name": "SweepSchedule"
}