Deposits

List Account Deposits

Retrieves a list of Account Deposits by accountID.

get/accounts/{accountID}/funding/deposits

Request

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

Path parameters

accountIDstring required

sensitive The user's unique account identifier.

Example:123e4567-e89b-12d3-a456-000000000004.1234567890125

sensitive

Query parameters

statusstring

Comma separated payment statuses

typestring

Comma separated deposit types

limitinteger

The number of deposits to be returned per page. Minimum=1, Maximum=100

offsetstring

Should either be null or the last payment result in the previous request

Response

Retrieving a list of Account Deposits was Successful.

idstring

A unique identifier for the Deposit.

paymentIDstring

A unique identifier for the Deposit.

type'ACH' | 'BULK_FUNDING' | 'CASH_PROMOTION' | 'CASH_TRANSFER'

The method/form in which the funds will be arriving to the user's account.

amountnumber

The amount of the deposit, in the deposit's currency.

wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

finTranReferencestring

The unique identifier that references back to the specific transaction.

notestring

sensitive A way to store a message/comment on the this object. Do not put personal or account data in this field.

timestampstring date-time

The date and time DriveWealth created the deposit.

returnedstring date-time

The date and time the bank returned the deposit. Omitted for deposits that remain unreturned.

reportableTaxYearinteger nullable

The tax year the IRA contribution deposit is reportable for, derived from the transaction date and iraContribution type. null for deposits that are not retirement-account contributions.

Example response

[
  {
    "id": "YYYY009000-1234567890136-1A2B3",
    "paymentID": "YYYY009000-1234567890136-1A2B3",
    "type": "ACH",
    "amount": 125.22,
    "currency": {
      "name": "USD",
      "description": "US Dollar",
      "symbol": "$"
    },
    "status": {
      "id": 1,
      "message": "PENDING",
      "updated": "2022-12-11T22:28:21.810Z"
    },
    "seasoningDetails": {
      "status": 2,
      "statusMessage": "SEASONING",
      "seasoningPeriodExpires": "2026-01-09T22:28:21.810Z",
      "depositBuyingPowerHoldExpires": "2026-01-09T22:28:21.810Z"
    },
    "accountDetails": {
      "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
      "accountNo": "FFFF000005",
      "accountType": {
        "name": "LIVE",
        "description": "Live Account"
      },
      "accountManagementType": {
        "name": "SELF",
        "description": "Self Directed Account"
      }
    },
    "fees": [
      {
        "type": "FEE_STATE_TAX_CA",
        "description": "Fee - ACH",
        "amount": -5.99,
        "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
        "transactionCode": "FEE_STATE_TAX_CA",
        "finTranReference": "HG.123e4567-e89b-12d3-a456-00000000004e",
        "created": "2022-12-11T22:28:21.810Z",
        "currency": "USD",
        "symbol": "$"
      }
    ],
    "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
    "finTranReference": "HG.123e4567-e89b-12d3-a456-00000000004e",
    "note": "Hey! Welcome to DriveWealth Developer Docs!",
    "timestamp": "2026-09-15T18:28:11.267Z",
    "returned": "2026-09-17T14:05:42.318Z",
    "reportableTaxYear": 2026
  }
]

Changes

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