DRdrivewealth
Deposits

Retrieve Recurring Deposits

Retrieves Recurring Deposits details by recurringID.

get/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.

Response

Fetching recurring deposit schedule 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.

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",
  "depositHistory": [
    {
      "depositID": "YYYY009000-1234567890136-1A2B3",
      "currency": "USD",
      "status": "PENDING",
      "created": "2022-12-11T22:28:21.810Z",
      "updated": "2022-12-11T22:28:21.810Z",
      "createdBy": "123e4567-e89b-12d3-a456-00000000005e",
      "metaAccountInfo": "Automated DAILY recurring deposit for b25f0d3... |MyBank Premier Checking|****5204"
    }
  ]
}

Changes

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