@adyen/api-library/lib/src/typings/configurationWebhooks/balanceAccount.d.ts

The Adyen API Library for NodeJS enables you to work with Adyen APIs.

import { Balance } from "./balance";
import { PlatformPaymentConfiguration } from "./platformPaymentConfiguration";
export declare class BalanceAccount {
    /**
    * The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/balanceplatform/latest/post/accountHolders#responses-200-id) associated with the balance account.
    */
    "accountHolderId": string;
    /**
    * List of balances with the amount and currency.
    */
    "balances"?: Array<Balance>;
    /**
    * The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. This is the currency displayed on the Balance Account overview page in your Customer Area. The default value is **EUR**. > After a balance account is created, you cannot change its default currency.
    */
    "defaultCurrencyCode"?: 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.
    */
    "description"?: string;
    /**
    * The unique identifier of the balance account.
    */
    "id": string;
    /**
    * 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 existing key-value pairs will result in the deletion of those key-value pairs.
    */
    "metadata"?: {
        [key: string]: string;
    };
    /**
    * The unique identifier of the account of the migrated account holder in the classic integration.
    */
    "migratedAccountCode"?: string;
    "platformPaymentConfiguration"?: PlatformPaymentConfiguration | null;
    /**
    * Your reference for the balance account, maximum 150 characters.
    */
    "reference"?: string;
    /**
    * The status of the balance account, set to **active** by default.
    */
    "status"?: BalanceAccount.StatusEnum;
    /**
    * 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](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
    */
    "timeZone"?: string;
    static readonly discriminator: string | undefined;
    static readonly mapping: {
        [index: string]: string;
    } | undefined;
    static readonly attributeTypeMap: Array<{
        name: string;
        baseName: string;
        type: string;
        format: string;
    }>;
    static getAttributeTypeMap(): {
        name: string;
        baseName: string;
        type: string;
        format: string;
    }[];
    constructor();
}
export declare namespace BalanceAccount {
    enum StatusEnum {
        Active = "active",
        Closed = "closed",
        Inactive = "inactive",
        Suspended = "suspended"
    }
}