Adyen · Schema

BalanceAccount

PaymentsFinancial ServicesFintech

Properties

Name Type Description
accountHolderId string The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account.
balances array List of balances with the amount and currency.
defaultCurrencyCode string The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created,
description string 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.
id string The unique identifier of the balance account.
metadata object A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of e
migratedAccountCode string The unique identifier of the account of the migrated account holder in the classic integration.
platformPaymentConfiguration object Contains key-value pairs to the configure the settlement model in a balance account.
reference string Your reference for the balance account, maximum 150 characters.
status string The status of the balance account, set to **active** by default.
timeZone string The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](
View JSON Schema on GitHub

JSON Schema

adyen-balanceaccount-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BalanceAccount",
  "title": "BalanceAccount",
  "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.",
      "readOnly": true,
      "type": "string"
    },
    "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"
  ],
  "type": "object"
}