Add Settlement Schedule

Parameters

The following parameters are available to properly update a settlement schedule.

parameter	description	required
name	the name of the settlement schedule	No
description	the description of the settlement schedule	No
bank_token	the bank account token associated with this merchant's bank account	Yes
schedule	the schedule frequency of the settlement schedule Possible request values are `daily`, `weekly`, `monthly`, and `annually`	Yes
schedule_factor	the multiplier to the settlement schedule For example: A request with a `daily` schedule and a schedule factor of `2` will make settlements every other day, a schedule factor of `3` will settle every third day and so on...	No
start_date	the date that the settlement schedule will start Note: The date is in `YYYYMMDD` form and must be set on a Tuesday through Friday	No
amount	the amount to be settled	Yes
unit_of_measure	the unit of measure that the settlement is using to calculate how much is being settled Possible request values are `actual` for a specific dollar amount being settled and `percent` for a percent amount being settled	Yes
minimum	the minimum amount required for a settlement	No
maximum	the maximum amount of a settlement	No
float	the minimum amount that is desired to stay inside of an account's balance	No
off_days	indicates whether or not that holidays and weekends will create a settlement Possible request values are `0` = do not skip off days and `1` = skip off days	No
same_day	indicates whether a settlement will be made the same day this update is requested Possible request values are `0` = not same day and `1` = is same day	No
is_inactive	indicates whether or not the settlement schedule is active Possible request values are `0` = active and `1` = inactive	No
is_frozen	indicates whether or not the settlement schedule is frozen Possible request values are `0` = not frozen and `1` = frozen	No

JSON Example

The following JSON example provides test values to add a settlement schedule. You can copy and paste these values in the Body Params section above to be used by the Try It feature

{
    "schedule": "weekly",
    "bank_token": "{bank_account_token}",
    "name": "release",
    "description": "release reserve",
    "start_date": "20201225",
    "unit_of_measure": "actual",
    "schedule_factor": 1,
    "amount": 2.00
}