BalanceAccountUpdateRequest is a JSON Structure definition published by Adyen, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/configuration-balance-account-update-request-structure.json",
"description": "BalanceAccountUpdateRequest 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"
},
"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"
},
"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"
},
"platformPaymentConfiguration": {
"description": "Contains key-value pairs to the configure the settlement model in a balance account.",
"$ref": "#/components/schemas/PlatformPaymentConfiguration"
},
"reference": {
"description": "Your reference to the balance account, maximum 150 characters.",
"maxLength": 150,
"type": "string"
},
"status": {
"description": "The status of the balance account. Payment instruments linked to the balance account can only be used if the balance account status is **active**.\n\nPossible values: **active**, **inactive**, **closed**, **suspended**.",
"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"
}
},
"name": "BalanceAccountUpdateRequest"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.