Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Deposits

Update Deposit ACH Settlement

Updates the ACH settlement dates for a deposit by depositID.

patch/funding/deposits/{depositID}/achSettlement

Path parameters

depositIDstring required

A unique identifier for the Deposit.

Example:-DMIQY

A unique identifier for the user's account deposit.

Request body

depositBuyingPowerHoldExpiresstring date

The date when the buying power hold on the deposit expires. Will allocate buying power if set to today or a prior date.

seasoningPeriodExpiresstring date

The date when the withdrawal power hold on the deposit expires. Will allocate withdrawal power if set to today or a prior date.

Example request

{
  "depositBuyingPowerHoldExpires": "2026-05-12",
  "seasoningPeriodExpires": "2026-05-13"
}

Response

Updating the ACH Settlement dates was Successful.

idstring

A unique identifier created for each User on DriveWealth's platform.

categorystring
amountnumber

The amount of cash that is being deposited into the user's account.

status'STARTED' | 'PENDING' | 'PROCESSING' | 'SUCCESSFUL' | 'FAILED' | 'OTHER' | 'APPROVED' | 'REJECTED' | 'ON_HOLD' | 'PROCESSING' | 'RETURNED' | '-'

The current status of the user's deposit.

createdstring
batchboolean
notestring

A way to store a message/comment on the this object.

wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

iraContribution'CURRENT_YEAR' | 'PRIOR_YEAR' | 'POSTPONED_CONTRIBUTION' | 'REPAYMENT' | 'SEC_128_EMPLOYER' | 'OTHER_SOURCE' | 'QUALIFIED_ROLLOVER' | 'PILOT_PROGRAM' | 'QUALIFIED_GENERAL'

The type of contribution deposit for retirement accounts.

Note: Trump accounts have their own enums. Click here for more details.

iraContributionSubType'SC' | 'PO' | 'FD' | 'EO' | 'PL' | 'QR' | 'DD' | 'BA' | 'EP' | 'DA' | 'TI'

The sub type to be used for POSTPONED_CONTRIBUTION or REPAYMENT contributions for retirement accounts. Click here for more details.

Example response

{
  "id": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
  "category": "DEPOSIT",
  "amount": 250.25,
  "currency": {
    "name": "USD",
    "description": "US Dollar",
    "symbol": "$"
  },
  "status": "PENDING",
  "seasoningDetails": {
    "status": 2,
    "statusMessage": "SEASONING",
    "seasoningPeriodExpires": "2026-01-09T22:28:21.810Z",
    "depositBuyingPowerHoldExpires": "2026-01-09T22:28:21.810Z"
  },
  "created": "2022-12-11T22:28:21.810Z",
  "userDetails": {
    "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
    "username": "ttc.user.justin",
    "firstName": "Justin",
    "lastName": "Smith",
    "email": "jj@drivewealth.dev",
    "parentIBID": {
      "id": "80f9b672-120d-4b73-9cc9-42fb3262c4b9",
      "name": "Tendies Trading Company"
    },
    "wlpID": "TTC",
    "settlementProfileID": "settlement-profile-bank-account-1"
  },
  "accountDetails": [
    {
      "id": "8b8ba3fd-74dc-45dc-b2dc-7de683bd713c.1556222995391",
      "accountNo": "DWBG000052",
      "nickname": "Justin's Self Directed Account",
      "status": {
        "name": "PENDING",
        "description": "Pending"
      },
      "accountType": "LIVE",
      "accountManagementType": "SELF",
      "tradingType": {
        "name": "CASH",
        "description": "Cash Account"
      },
      "leverage": 1,
      "commissionID": "449d41b9-3940-41ff-b0e6-334adfb443f8",
      "userID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
      "bod": {
        "moneyMarket": 3028.98,
        "equityValue": 12071.5,
        "cashAvailableForWithdrawal": 3028.98,
        "cashAvailableForTrading": 3028.98,
        "updatedWhen": "2022-12-12T21:13:12.391Z"
      },
      "cashBalance": 3028.98,
      "sweepInd": true,
      "createdWhen": "2022-12-11T22:28:21.810Z",
      "updatedWhen": "2022-12-11T22:28:21.810Z",
      "lastActivityDate": "2024-07-23",
      "interestedParties": [
        {
          "data": [
            {
              "id": "cc07f91b-7ee1-4868-b8fc-823c70a1b932",
              "from": "2022-12-25T22:28:21.810Z",
              "to": "2022-12-26T22:28:21.810Z"
            }
          ]
        }
      ]
    }
  ],
  "batch": true,
  "transactionCode": {
    "code": "JOURNAL",
    "type": "CSR",
    "description": "Cash Receipt - ACH"
  },
  "note": "Hey! Welcome to DriveWealth Developer Docs!",
  "details": {
    "country": "USA",
    "bankAccountNumber": "****3174",
    "bankRoutingNumber": "****0000",
    "accountHolderName": "Justin Smith"
  },
  "wlpFinTranTypeID": "c43bab85-2916-4831-a0db-66215150a6e4",
  "iraContribution": "POSTPONED_CONTRIBUTION",
  "iraContributionSubType": "SC",
  "statusHistory": [
    {
      "status": 1,
      "statusMessage": "PENDING",
      "updatedBy": "SYSTEM",
      "comment": "Valid request. Auto-move to Pending"
    }
  ]
}