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

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

export declare class AccountPayoutConfigWebhookData {
    /**
    * The unique identifier of the balance account to which the payout schedule was applied.
    */
    "balanceAccountId"?: string;
    /**
    * The unique identifier of the balance platform payout schedule that was applied to the balance account.
    */
    "balanceAccountPayoutScheduleId"?: string;
    /**
    * The unique identifier of the balance platform.
    */
    "balancePlatform"?: string;
    /**
    * The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for this schedule.
    */
    "currency"?: string;
    /**
    * The description used for all payouts initiated by this payout schedule.  Maximum length: 140 characters. If your description is longer, it may be truncated.
    */
    "description"?: string;
    /**
    * Specifies whether the payout schedule is active.
    */
    "enabled"?: boolean;
    /**
    * The frequency of payouts initiated by this payout schedule.  Possible values: * daily * weekdays * weekly * monthly
    */
    "frequency"?: string;
    /**
    * The date of the month or day of the week when payouts are initiated. Allowed only if `frequency` is **monthly** or **weekly**.  Possible values if `frequency` is **monthly**: **[1 - 31]**. * If your specified date happens on a weekend, the payout is initiated on the next business day. * If your specified date (**29**, **30**, or **31**) does not exist in a month, the payout is initiated on the last day of that month.  Possible values if `frequency` is **weekly**: **[1 - 5]**.
    */
    "frequencyValue"?: number;
    /**
    * The maximum amount that can be paid out from balance accounts that use this payout schedule.
    */
    "maxPayoutAmount"?: number;
    /**
    * The minimum amount that can be paid out from balance accounts that use this payout schedule.
    */
    "minPayoutAmount"?: number;
    /**
    * Your internal reference of the payout schedule.
    */
    "reference"?: string;
    /**
    * The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the transfer and is included in all webhooks related to the payout.  Supported characters: **a-z**, **A-Z**, **0-9**, **-** and space. Spaces might be replaced with **-** if the recipient bank or payment infrastructure does not allow spaces.
    */
    "referenceForBeneficiary"?: string;
    /**
    * The amount of funds that must remain available in the balance account after an execution of the payout schedule. If the funds in the balance account are less than the retained amount, the execution is not initiated.
    */
    "retainedAmount"?: number;
    /**
    * The time of day when the sales day is closed in balance account time zone. The sales day closing time can be between 00:00 to 07:00.  Format: **HH:mm:SS**
    */
    "salesDayClosingTime"?: string;
    /**
    * The unique identifier of the transfer instrument to which the funds are paid out.
    */
    "transferInstrumentId"?: 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();
}