Update the payout schedule
PUT
Creates a new version of the schedule. The next payout uses it.
apiKeyheader
AuthorizationBasic <token>HTTP Basic authentication with an admin API key as the username and an empty password.
payout_entity_id*stringThe ID of the payout entity.
Format
uuidapplication/json- body
The payout schedule.
frequency*stringValue in
"daily""weekly""monthly"day?|null for daily, 1 (Monday) to 7 (Sunday) for weekly, 1 to 31 for monthly. 29 to 31 fall back to the last day of shorter months.
Range
1 <= value <= 31delay_days*integerDays between the completion of a transaction and the moment it can be paid out.
Range
0 <= valuecutoff_time*stringThe end of the merchant's day, as HH:MM (24 hours).
Match
^([01][0-9]|2[0-3]):[0-5][0-9]$cutoff_timezone*stringIANA timezone of the cutoff time.
The new version of the schedule.
curl -X PUT 'https://api.example.com/v1/admin/payouts/payout-entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/payout-settings/' \ --user "$API_KEY:" \ -H 'Content-Type: application/json' \ -d '{ "frequency": "monthly", "day": 1, "delay_days": 7, "cutoff_time": "23:59", "cutoff_timezone": "Europe/Amsterdam"}'Empty