API Reference

Update Sweep Account

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

Update existing sweep settings between two accounts

Path Params
int64
required

The id of the sweep account setting to update.

Body Params

Update sweep request.

string
length between 3 and 20

Destination account number to sweep to

string
enum

Account Sweeping Schedule Type. One of Automatic or Scheduled

Allowed:
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

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

boolean

Whether to enable or disable this account sweeping configuration

Headers
string
length ≤ 128

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

Responses

Updated about 1 month ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago