Update a managed payout schedule on a balance account
Update a managed payout schedule applied to a balance account. If an optional parameter is not included in the request, it remains unchanged.
Path parameters
The unique identifier of the balance account.
The unique identifier of the payout schedule applied to the balance account.
Request body
The description used for all payouts initiated by this payout schedule.
Maximum length: 140 characters. If your description is longer, it may be truncated.
Default value: The defaultDescription from the balance platform schedule that you are applying.
Specifies whether the payout schedule is enabled immediately after it is created.
The frequency of payouts initiated by this payout schedule.
Possible values:
- daily
- weekdays
- weekly
- monthly
Default value: The defaultFrequency from the balance platform schedule that you are applying.
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].
Default value: The defaultFrequencyValue from the balance platform schedule that you are applying.
The maximum amount that can be paid out from balance accounts that use this payout schedule.
Default value: 0
The minimum amount that can be paid out from balance accounts that use this payout schedule.
Default value: 0
The merchant reference that will be shown only in the schedule.
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.
Default value: The defaultReferenceForBeneficiary from the balance platform schedule that you are applying.
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.
Default value: 0
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
The unique identifier of the transfer instrument to which the funds are paid out.
Response
OK - The request has succeeded.
The unique identifier of the balance account to which you apply the payout schedule.
The unique identifier of the balance platform payout schedule that is applied to the balance account.
The date and time when the payout schedule was created.
The three-character ISO code of the currency used for this schedule.
The description used for all payouts initiated by this payout schedule.
Maximum length: 140 characters. If your description is longer, it may be truncated.
Default value: The defaultDescription from the balance platform schedule that you are applying.
Specifies whether the payout schedule is active.
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].
Default value: The defaultFrequencyValue from the balance platform schedule that you are applying.
The unique identifier of the payout schedule for the balance account.
The maximum amount that can be paid out from balance accounts that use this payout schedule.
Default value: 0
The minimum amount that can be paid out from balance accounts that use this payout schedule.
Default value: 0
Your reference for the payout schedule. This reference does not appear on statements of payouts initiated by the payout schedule.
The reference for beneficiary used for all payouts initiated by this payout schedule. This reference is sent to the recipient of the payout and is included in all webhooks related to the payout.
Supported characters: a-z, A-Z, 0-9.
Default value: The defaultReferenceForBeneficiary from the balance platform schedule that you are applying.
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.
Default value: 0
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
The unique identifier of the transfer instrument to which the funds are paid out.
The date and time when the payout schedule was updated.