BalanceAccount

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/notification-webhooks-balance-account-schema.json",
  "title": "BalanceAccount",
  "description": "BalanceAccount schema from Adyen API",
  "properties": {
    "accountHolderId": {
      "description": "The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.",
      "type": "string"
    },
    "balances": {
      "description": "List of balances with the amount and currency.",
      "items": {
        "$ref": "#/components/schemas/Balance"
      },
      "type": "array"
    },
    "defaultCurrencyCode": {
      "description": "The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account.\nThe default value is **EUR**.",
      "type": "string"
    },
    "description": {
      "description": "A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder.",
      "maxLength": 300,
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the balance account.",
      "type": "string"
    },
    "paymentInstruments": {
      "description": "List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments) associated with the balance account.",
      "items": {
        "$ref": "#/components/schemas/PaymentInstrumentReference"
      },
      "type": "array"
    },
    "reference": {
      "description": "Your reference for the balance account, maximum 150 characters.",
      "maxLength": 150,
      "type": "string"
    },
    "status": {
      "description": "The status of the balance account, set to **Active** by default. \n",
      "enum": [
        "Active",
        "Closed",
        "Inactive",
        "Suspended"
      ],
      "type": "string"
    },
    "sweepConfigurations": {
      "additionalProperties": {
        "$ref": "#/components/schemas/SweepConfiguration"
      },
      "description": "Contains key-value pairs that specify configurations for balance sweeps per currency code. A sweep pulls in or pushes out funds based on a defined schedule, amount, and a source (for pulling funds) or a destination (for pushing funds).\n\nThe key must be a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The value must be an object containing the sweep configuration.",
      "type": "object"
    },
    "timeZone": {
      "description": "The [time zone](https://www.iana.org/time-zones) of the balance account. For example, **Europe/Amsterdam**.\nIf not set, the time zone of the account holder will be used. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
      "type": "string"
    }
  },
  "required": [
    "accountHolderId",
    "id"
  ],
  "type": "object"
}