Account Sweeping

openapi: 3.0.1 info: title: Victor REST API version: 2.0.0 servers: - url: https://api.stage.victorfi.com description: Victor Staging Environment - url: https://api.victorfi.com description: Victor Production Environment tags: - name: Account Sweeping description: Sweep Account Controller paths: /v2/sweep: get: tags: - Account Sweeping summary: List Sweep Accounts description: Returns a list of sweep accounts. operationId: getAccountSweeps responses: '200': description: Request succeeded. content: application/json: schema: type: array items: $ref: '#/components/schemas/UpsertSweepResponse' post: tags: - Account Sweeping summary: Create Sweep Account description: Create new sweep settings between two accounts operationId: createSweep parameters: - in: header name: Idempotency-Key schema: type: string example: 1145f601-b8b0-4de7-9210-4ccb74a68ef5 description: A client provided unique value used by the server to identify subsequent retries of the same request. maxLength: 128 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSweepRequest' required: true responses: '200': description: Request succeeded. content: application/json: schema: $ref: '#/components/schemas/UpsertSweepResponse' '400': description: Invalid create sweep request. content: application/json: schema: $ref: '#/components/schemas/ValidationErrors' /v2/sweep/{sweepId}: get: tags: - Account Sweeping summary: Get Sweep Account description: Returns the details of a sweep account. operationId: getAccountSweep parameters: - name: sweepId in: path required: true schema: type: integer format: int64 responses: '200': description: Request succeeded. content: application/json: schema: $ref: '#/components/schemas/UpsertSweepResponse' '404': description: Account sweep not found. put: tags: - Account Sweeping summary: Update Sweep Account description: Update existing sweep settings between two accounts operationId: updateSweep parameters: - in: header name: Idempotency-Key schema: type: string example: 1145f601-b8b0-4de7-9210-4ccb74a68ef5 description: A client provided unique value used by the server to identify subsequent retries of the same request. maxLength: 128 required: false - name: sweepId in: path description: The id of the sweep account setting to update. required: true schema: type: integer format: int64 requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSweepRequest' required: true responses: '200': description: Request succeeded. content: application/json: schema: $ref: '#/components/schemas/UpsertSweepResponse' '404': description: Sweep account not found. content: application/json: schema: $ref: '#/components/schemas/UpsertSweepResponse' delete: tags: - Account Sweeping summary: Delete Sweep Account description: Delete existing sweep settings between two accounts operationId: deleteSweep parameters: - name: sweepId in: path description: The identifier of the sweep account setting to delete. required: true schema: type: integer format: int64 responses: '200': description: Request succeeded. '404': description: Account sweep not found. components: schemas: ConfigurationProperty: properties: name: $ref: '#/components/schemas/ConfigurationPropertyName' origin: $ref: '#/components/schemas/Origin' value: type: object type: object ConfigurationPropertyName: properties: empty: type: boolean lastElementIndexed: type: boolean numberOfElements: format: int32 type: integer parent: $ref: '#/components/schemas/ConfigurationPropertyName' type: object CreateSweepRequest: required: - destination_account_number - source_account_number type: object properties: source_account_number: maxLength: 20 minLength: 3 pattern: '[0-9]+' type: string description: Source account number to sweep from destination_account_number: maxLength: 20 minLength: 3 pattern: '[0-9]+' type: string description: Destination account number to sweep to schedule_type: type: string description: Account Sweeping Schedule Type. One of Automatic or Scheduled enum: - Automatic - Scheduled schedule_time: type: string description: "Schedule time when scheduleType is set to Scheduled. Format is ISO-8601 extended local time format\ \ which represents time without offset. Example: 10:15.\n Defaults to 6PM if not specified" schedule_timezone: type: string description: "Schedule time zone when scheduleType is set to Scheduled. Must be a valid time zone, for example America/New_York.\n\ \ Defaults to America/New_York if not specified" description: Create sweep request. ObjectError: properties: arguments: items: type: object type: array code: type: string codes: items: type: string type: array defaultMessage: type: string objectName: type: string type: object Origin: properties: parent: $ref: '#/components/schemas/Origin' type: object UpdateSweepRequest: type: object properties: destination_account_number: maxLength: 20 minLength: 3 pattern: '[0-9]+' type: string description: Destination account number to sweep to schedule_type: type: string description: Account Sweeping Schedule Type. One of Automatic or Scheduled enum: - Automatic - Scheduled schedule_time: type: string description: "Schedule time when scheduleType is set to Scheduled. Format is ISO-8601 extended local time format\ \ which represents time without offset. Example: 10:15.\n Defaults to 6PM if not specified" schedule_timezone: type: string description: "Schedule time zone when scheduleType is set to Scheduled. Must be a valid time zone, for example America/New_York.\n\ \ Defaults to America/New_York if not specified" enabled: type: boolean description: Whether to enable or disable this account sweeping configuration description: Update sweep request. UpsertSweepResponse: type: object properties: sweep_id: type: integer format: int64 source_account_number: type: string destination_account_number: type: string account_sweep_schedule_type: type: string enum: - AUTOMATIC - SCHEDULED schedule_time: type: string schedule_timezone: type: string enabled: type: boolean ValidationErrors: properties: allErrors: items: $ref: '#/components/schemas/ObjectError' type: array boundProperties: items: $ref: '#/components/schemas/ConfigurationProperty' type: array uniqueItems: true name: $ref: '#/components/schemas/ConfigurationPropertyName' type: object

Please ignore this field