Create Sweep Account

post

https://api.stage.victorfi.com/v2/sweep

Create new sweep settings between two accounts

Body Params

Create sweep request.

source_account_number

string

required

length between 3 and 20

[0-9]+

Source account number to sweep from

destination_account_number

string

required

length between 3 and 20

[0-9]+

Destination account number to sweep to

schedule_type

string

enum

Account Sweeping Schedule Type. One of Automatic or Scheduled

Allowed:

schedule_time

string

Schedule time when scheduleType is set to Scheduled. Format is ISO-8601 extended local time format which represents time without offset. Example: 10:15.
Defaults to 6PM if not specified

schedule_timezone

string

Schedule time zone when scheduleType is set to Scheduled. Must be a valid time zone, for example America/New_York.
Defaults to America/New_York if not specified

Headers

Idempotency-Key

string

length ≤ 128

A client provided unique value used by the server to identify subsequent retries of the same request.

Responses

200Request succeeded.

400Invalid create sweep request.