DRdrivewealth
Deposits

List User Recurring Deposits

Retrieves a list of User Recurring Deposits by userID.

get/users/{userID}/recurring-deposits

Request

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

Path parameters

userIDstring required

sensitive The User's unique identifier.

Response

Fetching All User's Recurring Deposits was Successful.

idstring

A unique identifier of the recurring deposit.

currency'USD'

The name of the currency in abbreviation form.

amountnumber

The amount of the recurring deposit.

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.

bankAccountIDstring

The unique DriveWealth identifier that identifies each linked bank account.

activeboolean

True, if the recurring deposit is active.

nextDepositstring

The date of when the next recurring deposit will be triggered.

accountIDstring

sensitive The user's unique account identifier.

createdstring

The date and time the recurring deposit was created for the user's external bank account.

updatedstring

The date and time the recurring deposit was updated for the user's external bank account.

createdBystring

The user identifier whom created the recurring deposit.

Example response

[
  {
    "id": "recurring_123e4567-e89b-12d3-a456-00000000004d",
    "currency": "USD",
    "amount": 1075.25,
    "frequency": "MONTHLY_FIRST",
    "bankAccountID": "bank_123e4567-e89b-12d3-a456-00000000004a",
    "active": true,
    "nextDeposit": "2019-01-15",
    "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
    "created": "2022-12-11T22:28:21.810Z",
    "updated": "2022-12-11T22:28:21.810Z",
    "createdBy": "123e4567-e89b-12d3-a456-00000000005e"
  }
]

Changes

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