Adyen · JSON Structure

Accounts Update Account Request Structure

UpdateAccountRequest schema from Adyen API

Type: object Properties: 7 Required: 1
PaymentsFinancial ServicesFintech

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

Properties

accountCode bankAccountUUID description metadata payoutMethodCode payoutSchedule payoutSpeed

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/accounts-update-account-request-structure.json",
  "description": "UpdateAccountRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "accountCode": {
      "description": "The code of the account to update.",
      "type": "string"
    },
    "bankAccountUUID": {
      "x-addedInVersion": "5",
      "description": "The bankAccountUUID of the bank account held by the account holder to couple the account with. Scheduled payouts in currencies matching the currency of this bank account will be sent to this bank account. Payouts in different currencies will be sent to a matching bank account of the account holder.",
      "type": "string"
    },
    "description": {
      "x-addedInVersion": "4",
      "description": "A description of the account, maximum 256 characters.You can use alphanumeric characters (A-Z, a-z, 0-9), white spaces, and underscores `_`.",
      "type": "string"
    },
    "metadata": {
      "x-addedInVersion": "5",
      "additionalProperties": {
        "type": "string"
      },
      "description": "A set of key and value pairs for general use by the merchant.\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"
    },
    "payoutMethodCode": {
      "x-addedInVersion": "5",
      "description": "The payout method code held by the account holder to couple the account with. Scheduled card payouts will be sent using this payout method code.",
      "type": "string"
    },
    "payoutSchedule": {
      "description": "The details of the payout schedule, to which the account should be updated.",
      "$ref": "#/components/schemas/UpdatePayoutScheduleRequest"
    },
    "payoutSpeed": {
      "x-addedInVersion": "5",
      "description": "Speed with which payouts for this account are processed. Permitted values: `STANDARD`, `SAME_DAY`.",
      "enum": [
        "INSTANT",
        "SAME_DAY",
        "STANDARD"
      ],
      "type": "string"
    }
  },
  "required": [
    "accountCode"
  ],
  "name": "UpdateAccountRequest"
}