--- title: "List Deposits" method: GET path: "/funding/deposits" tags: ["Deposits"] --- # List Deposits `GET /funding/deposits` Retrieves a list of Deposits. ## Query parameters - `status` 'STARTED' | 'PENDING' | 'PROCESSING' | 'SUCCESSFUL' | 'FAILED' | 'OTHER' | 'APPROVED' | 'REJECTED' | 'ON_HOLD' | 'PROCESSING' | 'RETURNED' | '-', required — The current status of the user's deposit. - `type` 'ACH' | 'BULK_FUNDING' | 'CASH_PROMOTION' | 'CASH_TRANSFER', required — The method/form in which the funds will be arriving to the user's account. - `from` string, required - `to` string, required - `direction` 'prev' | 'next' - `parentIBID` string — The partner's unique identifier. ## Response `200` Retrieving a list of Deposits was Successful. - DepositListItem[] — A list of all deposits for the firm. - `id` string — 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. - `amount` number — The amount of the deposit - `currency` CurrencyObject - `name` 'USD' — The name of the currency in abbreviation form. - `description` string — A custom description about the currency. - `symbol` '$' — The currency symbol. - `details` object - `country` string — The country where the user's external bank is located. - `bankAccountNumber` string — The last four digits of the user's external bank account number. - `bankRoutingNumber` string — The last four digits of the user's external bank routing number. - `accountHolderName` string — The full name of the user on the external bank account. - `status` DepositStatusObject - `id` 0 | 1 | 2 | 3 | 4 | 14 | 15 | 16 | 17 | 5 | -1 — The current status of the user's deposit in integer form. - `message` 'STARTED' | 'PENDING' | 'PROCESSING' | 'SUCCESSFUL' | 'FAILED' | 'OTHER' | 'APPROVED' | 'REJECTED' | 'ON_HOLD' | 'PROCESSING' | 'RETURNED' | '-' — The current status of the user's deposit. - `updated` string - `userDetails` FundingUserDetails - `userID` string — A unique identifier created for each User on DriveWealth's platform. - `username` string — The username of the user. - `firstName` string — The first name of the user. - `lastName` string — The last (family) name of the user. - `email` string — The user's email address. - `parentIBID` ParentIBIDObject - `id` string — The unique identifier of an associated organization. - `name` string — The organization name. - `wlpID` string — The wlpID is a deep backoffice ID that identifies each partner from each other. - `settlementProfileID` string — A settlement profile identifier that links to a specific bank account for fund settlement. - `accountDetails` Account[] — A list of all the user's accounts at DriveWealth. - `id` string — The user's unqiue account identifier. - `accountNo` string — The user's unqiue account number, that is human readable. - `nickname` string - `status` object - `name` string — The status of the user's account. - `description` string — A custom description about status of the user's account. - `accountType` string — The type of account that has been created. - `accountManagementType` 'SELF' | 'ADVISORY' | 'RIA_MANAGED' | 'CUSTODIAL' | 'CUSTODIAL_MANAGED' | 'RESERVED' | 'HSA_SELF' | 'HSA_ADVISORY' | 'HSA_RIA_MANAGED' | 'BUSINESS_SELF' | 'BUSINESS_ADVISORY' | 'BUSINESS_RIA_MANAGED' — The type of account who has trading authority. - `tradingType` object - `name` 'CASH' | 'MARGIN' | 'CRYPTO' — The type of trading ocurring in the account. - `description` string — A custom description about the type of account. - `leverage` number — The leverage that is applied to the user's account. - `commissionID` string — The unique identifier for the assiocated commission schedule. - `userID` string — The user's unique identifier. - `restricted` boolean — True, if the user is restricted from trading. - `goodFaithViolations` number — The amount of times that a user buy a security and sell it before paying for the inital purchase in full with settled funds. - `patternDayTrades` number — The number of times a user buys and sells the same security in the same day over a seven-day period. - `freeTradeBalance` number - `gfvPdtExempt` boolean - `buyingPowerOverride` boolean — True, if buying power check turned off. - `bod` object — Beginning of Day Information, *⚠️ Only updated at the beginning of day, this information will not change interaday.* - `moneyMarket` number — The amount of money the user's has in money market for this account. - `equityValue` number — The value of the sum of all equities in the account. - `cashAvailableForWithdrawal` number — The amount of money available for withdrawal. - `cashAvailableForTrading` number — The amount of money available for trading. - `updatedWhen` string — The date and time the dob job was run. - `cashBalance` number — The amount of settled cash in the account. - `sweepInd` boolean — True, if the user's account cash is set to move into a bank sweep or money market account. - `interestFree` boolean — True, if the user will not be paid interest on the money in a bank sweep or money market account. - `createdWhen` string — The createdWhen is the date and time the user's account was created. - `updatedWhen` string — The updatedWhen is the last date and time the user's account was updated. - `lastActivityDate` string — The date indicating the last recorded activity of the account, across the partner's ecosystem. It's important to update this field regularly, as activity recency may impact functions like escheatment, and there may be activity occuring outside of the DriveWealth APIs. - `interestedParties` InterestedParty[] - `type` 'AUTHORIZED_USER' | 'CUSTODIAN' — The type of interested party. - `data` union[] — The list of interested parties. The shape of each item is determined by the sibling `type` field: when `type` is `AUTHORIZED_USER`, each item follows `interestedPartyAuthorizedUser`; when `type` is `CUSTODIAN`, each item follows `interestedPartyCustodian`. The item itself does not repeat the `type` field. - union - InterestedPartyAuthorizedUser - `id` string, required — A unique identifier created for each User on DriveWealth's platform. - `reportingRole` 'AUTH3RD' | 'AUTHREP' | 'NTHOLDER' | 'TRDHOLDER', required — The role of the interested party of the ID. - `tradeDiscretion` boolean, required — The trade discretion of the interested party of the ID. - `from` string, date-time, required — Time when the interested party role started - `to` string, date-time — Time when the interested party role ended - `endReason` 'CORRECTION' | 'ENDED' | 'INACTIVE' | 'REPLACED' | 'OTHER' | 'TRANSFER' — The reason the interested party role ended. - InterestedPartyCustodian - `id` string, required — A unique identifier created for each User on DriveWealth's platform. - `fees` FeeObject[] — A list of fees associated to the deposit. - `type` 'FEE_ACH', required — The type of fee that is being applied. - `description` string — A custom description that describes the fee type. - `amount` number, required — The amount of the fee that is being applied. - `wlpFinTranTypeID` string — A unique identifier to id different type of transactions. - `transactionCode` 'JOURNAL' | 'FEE_ACH' | 'DISBURSEMENT_ACH_SVB' - `finTranReference` string — The unique identifier that references back to the specific transaction. - `created` string — The timestamp of when the fee was charged. - `currency` 'USD' — The name of the currency in abbreviation form. - `symbol` '$' — The currency symbol. - `wlpFinTranTypeID` string — A unique identifier to id different type of transactions. - `transactionCode` TransactionCodeObject - `code` 'JOURNAL' | 'FEE_ACH' | 'DISBURSEMENT_ACH_SVB' - `type` 'CSR' | 'CSD' - `description` string — A custom description about the transaction code. --- [API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/revisions/9fced6d0ac41/schema)