Properties
| Name | Type | Description |
|---|---|---|
| action | string | Direction on how to handle any payouts that have already been scheduled. Permitted values: * `CLOSE` will close the existing batch of payouts. * `UPDATE` will reschedule the existing batch to the new |
| reason | string | The reason for the payout schedule update. > This field is required when the `schedule` parameter is set to `HOLD`. |
| schedule | string | The payout schedule to which the account is to be updated. Permitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_ |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/UpdatePayoutScheduleRequest",
"title": "UpdatePayoutScheduleRequest",
"properties": {
"action": {
"description": "Direction on how to handle any payouts that have already been scheduled.\nPermitted values:\n* `CLOSE` will close the existing batch of payouts.\n* `UPDATE` will reschedule the existing batch to the new schedule.\n* `NOTHING` (**default**) will allow the payout to proceed.",
"enum": [
"CLOSE",
"NOTHING",
"UPDATE"
],
"type": "string"
},
"reason": {
"description": "The reason for the payout schedule update.\n> This field is required when the `schedule` parameter is set to `HOLD`.",
"type": "string"
},
"schedule": {
"description": "The payout schedule to which the account is to be updated.\nPermitted values: `DAILY`, `DAILY_US`, `DAILY_EU`, `DAILY_AU`, `DAILY_SG`, `WEEKLY`, `WEEKLY_ON_TUE_FRI_MIDNIGHT`, `BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT`, `MONTHLY`, `HOLD`.\n`HOLD` will prevent scheduled payouts from happening but will still allow manual payouts to occur.",
"enum": [
"BIWEEKLY_ON_1ST_AND_15TH_AT_MIDNIGHT",
"DAILY",
"DAILY_AU",
"DAILY_EU",
"DAILY_SG",
"DAILY_US",
"HOLD",
"MONTHLY",
"WEEKLY",
"WEEKLY_MON_TO_FRI_AU",
"WEEKLY_MON_TO_FRI_EU",
"WEEKLY_MON_TO_FRI_US",
"WEEKLY_ON_TUE_FRI_MIDNIGHT",
"WEEKLY_SUN_TO_THU_AU",
"WEEKLY_SUN_TO_THU_US"
],
"type": "string"
}
},
"required": [
"schedule"
],
"type": "object"
}