DRdrivewealth
Withdrawals

Retrieve Withdrawal

Retrieves a Withdrawal by redemptionID.

get/funding/redemptions/{redemptionID}

Request

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

Path parameters

redemptionIDstring required

A unique identifier for the user's account redemption/withdrawal.

Example:ZZZZ009001-1234567890137-4X5Y6

Response

Retrieving a Withdrawal by redemptionID was Successful.

idstring

The unique identifier of the redemption/withdrawal.

categorystring

The category of the withdrawal.

createdstring
batchboolean
wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

notestring

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

remittanceInformationstring

For ACH, this field will be passed through on an addenda record used for additional remittance details to make it easier for a recipient to identify and apply payments. For wire payments, the field will be passed through as the "Originator to Beneficiary Information", also known as OBI or Fedwire tag 6000. This tag provides specific details about the purpose of the payment to the beneficiary. Character limit vary by bank and rail. Typical limits are 80 characters for ach payments and 140 characters for wire payments.

type'ACH' | 'WIRE' | 'CASH_TRANSFER' | 'BULK_FUNDING'

The method/form in which the redemption/withdrawal will be sent back to the user's external account.

iraDistribution'NORMAL_DISTRIBUTION' | 'EARLY_DISTRIBUTION' | 'EARLY_DISTRIBUTION_PENALTY_EXCEPTION' | 'DIRECT_ROLLOVER' | 'DIRECT_TRANSFER' | 'REQUIRED_MINIMUM_DISTRIBUTION' | 'DISTRIBUTION_TO_BENEFICIARY' | 'RETURN_OF_EXCESS_CONTRIBUTION' | 'QUALIFIED_CHARITABLE_CONTRIBUTION'

The type of redemption/withdrawal from an IRA type of account.

Note: Trump accounts follow specific requirements for external account transfers or distributions. Click here for more details.

iraDistributionSubType'SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T' | 'DISABILITY_OR_DEATH' | 'HIGHER_EDUCATION_EXPENSES' | 'FIRST_TIME_HOME_PURCHASE' | 'MEDICAL_EXPENSES' | 'HEALTH_INSURANCE_PREMIUMS' | 'RESERVIST_DISTRIBUTIONS'

These types are only applicable for the distribution type EARLY_DISTRIBUTION_PENALTY_EXCEPTION. 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": "AAAA009002-1234567890139-RIUIN",
  "category": "REDEMPTION",
  "currency": {
    "name": "USD",
    "description": "US Dollar",
    "symbol": "$"
  },
  "status": {
    "id": 1,
    "message": "PENDING",
    "updated": "2022-12-11T22: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": {
    "accountID": "123e4567-e89b-12d3-a456-000000000004.1234567890125",
    "accountNo": "FFFF000005",
    "accountType": {
      "name": "LIVE",
      "description": "Live Account"
    },
    "accountManagementType": {
      "name": "SELF",
      "description": "Self Directed Account"
    }
  },
  "batch": true,
  "transactionCode": {
    "type": "CSR",
    "description": "Cash Receipt - ACH"
  },
  "statusHistory": [
    {
      "status": 1,
      "statusMessage": "PENDING",
      "created": "2022-12-11T22:28:21.810Z",
      "updatedBy": "SYSTEM",
      "comment": "New redemption request from the back-office"
    }
  ],
  "details": {
    "beneficiaryName": "John Doe",
    "beneficiaryAccountNumber": "12345678901234567890123",
    "beneficiaryAccountType": "CHECKING",
    "beneficiaryRoutingNumber": "123456789",
    "beneficiarySwiftABA": "BOFAUS3NXXX",
    "beneficiaryBankName": "Bank of America",
    "beneficiaryBankAddress": "222 BROADWAY",
    "beneficiaryBankCity": "New York City",
    "beneficiaryBankProvince": "New York",
    "beneficiaryBankZip": "10038",
    "beneficiaryBankCountry": "USA",
    "intermediarySwift": "CHASUS3AXXX",
    "intermediaryBankName": "J.P Morgan Chase & Co."
  },
  "wlpFinTranTypeID": "123e4567-e89b-12d3-a456-00000000004c",
  "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": "$"
    }
  ],
  "note": "Hey! Welcome to DriveWealth Developer Docs!",
  "remittanceInformation": "Withdrawal from investment account",
  "type": "ACH",
  "iraDistribution": "EARLY_DISTRIBUTION_PENALTY_EXCEPTION",
  "iraDistributionSubType": "SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T",
  "metadata": {
    "myCustomKey": "myCustomValue"
  }
}

Changes

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