DRdrivewealth
Deposits

Update Deposit ACH Settlement

beta Updates the ACH settlement dates for a deposit by depositID.

patch/funding/deposits/{depositID}/achSettlement

Request

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

Path parameters

depositIDstring required

A unique identifier for the Deposit.

Example:YYYY009000-1234567890136-1A2B3

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 for the Deposit.

categorystring
amountnumber

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

createdstring
batchboolean
notestring

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

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' | 'PROMOTIONAL_EARNING' | 'CORRECTIVE_DEPOSIT'

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' | 'SU' | 'FR' | 'RF' | 'RB' | 'RL' | 'AT' | 'AF' | 'AD'

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

metadataMetadataMoneyMovement

sensitive The metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes. Do not put personal or account data in this field.

Example response

{
  "id": "YYYY009000-1234567890136-1A2B3",
  "category": "DEPOSIT",
  "amount": 250.25,
  "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"
  },
  "created": "2022-12-11T22:28:21.810Z",
  "userDetails": {
    "userID": "123e4567-e89b-12d3-a456-000000000004",
    "username": "ttc.user.john",
    "firstName": "John",
    "lastName": "Smith",
    "email": "john.doe@example.com",
    "parentIBID": {
      "id": "123e4567-e89b-12d3-a456-000000000005",
      "name": "Tendies Trading Company"
    },
    "wlpID": "TTC",
    "settlementProfileID": "settlement-profile-bank-account-1"
  },
  "accountDetails": [
    {
      "id": "123e4567-e89b-12d3-a456-00000000005c.1234567890143",
      "accountNo": "FFFF000005",
      "nickname": "John's Self Directed Account",
      "status": {
        "name": "PENDING",
        "description": "Pending"
      },
      "accountType": "LIVE",
      "accountManagementType": "SELF",
      "tradingType": {
        "name": "CASH",
        "description": "Cash Account"
      },
      "leverage": 1,
      "commissionID": "123e4567-e89b-12d3-a456-00000000005d",
      "userID": "123e4567-e89b-12d3-a456-000000000004",
      "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": "123e4567-e89b-12d3-a456-000000000004",
              "from": "2022-12-25T22:28:21.810Z",
              "to": "2022-12-26T22:28:21.810Z"
            }
          ]
        }
      ]
    }
  ],
  "batch": true,
  "transactionCode": {
    "type": "CSR",
    "description": "Cash Receipt - ACH"
  },
  "note": "Hey! Welcome to DriveWealth Developer Docs!",
  "details": {
    "country": "USA",
    "bankAccountNumber": "****3174",
    "bankRoutingNumber": "****0000",
    "accountHolderName": "John Doe"
  },
  "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
  "iraContribution": "POSTPONED_CONTRIBUTION",
  "iraContributionSubType": "SC",
  "statusHistory": [
    {
      "status": 1,
      "statusMessage": "PENDING",
      "updatedBy": "SYSTEM",
      "comment": "Valid request. Auto-move to Pending"
    }
  ],
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Changes

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