Adyen · JSON Structure

Configuration Webhooks Balance Account Structure

BalanceAccount schema from Adyen API

Type: object Properties: 12 Required: 2
PaymentsFinancial ServicesFintech

BalanceAccount is a JSON Structure definition published by Adyen, describing 12 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

accountHolderId balances defaultCurrencyCode description id metadata migratedAccountCode paymentInstruments platformPaymentConfiguration reference status timeZone

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/configuration-webhooks-balance-account-structure.json",
  "description": "BalanceAccount schema from Adyen API",
  "type": "object",
  "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**.\n> After a balance account is created, you cannot change its default currency.",
      "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"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "A set of key and value pairs for general use.\nThe keys do not have specific names and may be used for storing miscellaneous data as desired.\n> Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs.",
      "type": "object"
    },
    "migratedAccountCode": {
      "description": "The unique identifier of the account of the migrated account holder in the classic integration.",
      "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"
    },
    "platformPaymentConfiguration": {
      "description": "Contains key-value pairs to the configure the settlement model in a balance account.",
      "$ref": "#/components/schemas/PlatformPaymentConfiguration"
    },
    "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"
    },
    "timeZone": {
      "description": "The time zone of the balance account. For example, **Europe/Amsterdam**.\nDefaults to the time zone of the account holder if no time zone is set. 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"
  ],
  "name": "BalanceAccount"
}