DRdrivewealth
Deposits

Update Recurring Deposit

Updates Recurring Deposit details by recurringID.

patch/funding/recurring-deposits/{recurringID}

Request

  • Base URL
    https://bo-api.drivewealth.io/back-office
  • URL
    https://bo-api.drivewealth.io/back-office/funding/recurring-deposits/{recurringID}
  • Auth
    HTTP bearer

Path parameters

recurringIDstring required

A unique identifier for the user's recurring bank deposit.

Request body

amountnumber

The amount of the recurring deposit will be updated to.

frequency'BIWEEKLY' | 'DAILY' | 'MONTHLY' | 'MONTHLY_FIRST' | 'MONTHLY_MIDDLE' | 'QUARTERLY'

The recurring deposit frequency; only available for ACH deposits. Note: For retirement accounts, recurring schedules are restricted to CURRENT_YEAR contributions only.

Example request

{
  "amount": 330.25,
  "frequency": "MONTHLY_FIRST"
}

Response

Updating a User's recurring deposit was successful.

amountnumber

The amount of the recurring deposit will be updated to.

frequency'BIWEEKLY' | 'DAILY' | 'MONTHLY' | 'MONTHLY_FIRST' | 'MONTHLY_MIDDLE' | 'QUARTERLY'

The recurring deposit frequency; only available for ACH deposits. Note: For retirement accounts, recurring schedules are restricted to CURRENT_YEAR contributions only.

Example response

{
  "amount": 330.25,
  "frequency": "MONTHLY_FIRST"
}

Changes

No recorded changes to this operation across all 1 revision of this API.