Update a managed payout schedule on a balance account

patch/balanceAccounts/{balanceAccountId}/payoutSchedules/{id}

Update a managed payout schedule applied to a balance account. If an optional parameter is not included in the request, it remains unchanged.

Endpoint destination URL
https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{balanceAccountId}/payoutSchedules/{id}
idstringRequired

The unique identifier of the payout schedule applied to the balance account.

balanceAccountIdstringRequired

The unique identifier of the balance account.

descriptionstring, null

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.

enabledboolean, null

Specifies whether the payout schedule is enabled immediately after it is created.

frequencystring

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.

frequencyValueinteger, null

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.

maxPayoutAmountinteger, null

The maximum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0

minPayoutAmountinteger, null

The minimum amount that can be paid out from balance accounts that use this payout schedule.

Default value: 0

referencestring, null

The merchant reference that will be shown only in the schedule.

referenceForBeneficiarystring, null

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.

retainedAmountinteger, null

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

salesDayClosingTimestringDeprecated

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

transferInstrumentIdstring

The unique identifier of the transfer instrument to which the funds are paid out.

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

  • 401 - Unauthorized

    Authentication required.

  • 403 - Forbidden

    Insufficient permissions to process the request.

  • 404 - Not Found

    The resource was not found

  • 422 - Unprocessable Entity

    A request validation error.

  • 500 - Internal Server Error

    The server could not process the request.