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

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

export declare class PlatformPayoutConfigWebhookData {
    /**
    * The unique identifier of the balance platform.
    */
    "balancePlatform"?: string;
    /**
    * The unique identifier of the balance platform payout schedule that is applied to the balance account.
    */
    "balancePlatformPayoutScheduleId"?: string;
    /**
    * The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country to which the payout schedule applies.
    */
    "countryCode"?: string;
    /**
    * The three-character [ISO code](https://docs.adyen.com/development-resources/currency-codes) of the currency used for the payout schedule.
    */
    "currency"?: string;
    /**
    * The default description for payouts initiated by this payout schedule.
    */
    "defaultDescription"?: string;
    /**
    * The default frequency of payouts initiated by this payout schedule.
    */
    "defaultFrequency"?: string;
    /**
    * The default value for date of the month or day of the week when payouts are initiated. Allowed only if `defaultFrequency` 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 `defaultFrequency` is **weekly**: **[1 - 5]**.
    */
    "defaultFrequencyValue"?: number;
    /**
    * Your internal default reference for the payout schedule.  When the payout schedule is applied to a balance account, this reference is also used for that payout schedule, unless you specify a new reference.
    */
    "defaultReference"?: string;
    /**
    * The default reference for beneficiary for payouts initiated by this payout schedule.
    */
    "defaultReferenceForBeneficiary"?: string;
    /**
    * 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;
    /**
    * The amount of funds that must remain available in a 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;
    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();
}