@adyen/api-library
Version:
The Adyen API Library for NodeJS enables you to work with Adyen APIs.
95 lines (94 loc) • 4.09 kB
TypeScript
import { LocalTime } from "./localTime";
export declare class BalancePlatformConfiguration {
/**
* Specifies whether this payout schedule is automatically applied to new balance accounts.
*/
"automaticApplication"?: boolean;
/**
* The balance platform to which the payout schedule applies.
*/
"balancePlatformId": 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 date when the payout schedule was created.
*/
"createdAt": Date;
/**
* 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;
"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 `defaultFrequency` 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.
*/
"defaultReference"?: string;
/**
* The default reference for beneficiary for payouts initiated by this payout schedule.
*/
"defaultReferenceForBeneficiary"?: string;
/**
* Specifies whether the payout schedule is enabled immediately after it is created.
*/
"enabled"?: boolean;
/**
* The unique identifier of the payout schedule for your balance platform.
*/
"id"?: string;
/**
* The maximum amount that can be paid out from balance accounts that use this payout schedule. Default value: **0**, which means that there is no maximum limit.
*/
"maxPayoutAmount"?: number;
/**
* The minimum amount that can be paid out from balance accounts that use this payout schedule. Default value: **0**.
*/
"minPayoutAmount"?: number;
/**
* The type of payout schedule. This type indicates how fast funds are paid out to your user. Possible values: - **Standard**: The funds arrive in your user\'s transfer instrument two days after the funds are settled. - **Accelerated**: The funds arrive to your user\'s transfer instrument the day after the funds are settled.
*/
"payoutScheduleDescription": string;
/**
* 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. Default value: **0**
*/
"retainedAmount"?: number;
/**
* The date when the payout schedule was updated.
*/
"updatedAt"?: Date;
/**
* The default [settlement delay](https://docs.adyen.com/platforms/settle-funds/#settlement-delay) for this payout schedule.
*/
"userSettlementDelay": number;
"userSettlementTime": LocalTime;
/**
* The timezone of the `userSettlementTime`.
*/
"userSettlementTimeZone": string;
static readonly discriminator: string | undefined;
static readonly mapping: {
[]: 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();
}