Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Withdrawals

Retrieve Withdrawal

Retrieves a Withdrawal by redemptionID.

get/funding/redemptions/{redemptionID}

Path parameters

redemptionIDstring required

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

Example:-R8CC7

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

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

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

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.",

Example response

{
  "id": "-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": "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": {
    "accountID": "cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759",
    "accountNo": "DWBG000052",
    "accountType": {
      "name": "LIVE",
      "description": "Live Account"
    },
    "accountManagementType": {
      "name": "SELF",
      "description": "Self Directed Account"
    }
  },
  "batch": true,
  "transactionCode": {
    "code": "JOURNAL",
    "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": "Justin Smith",
    "beneficiaryAccountNumber": "00257596002028990212396",
    "beneficiaryAccountType": "CHECKING",
    "beneficiaryRoutingNumber": "021000322",
    "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": "c43bab85-2916-4831-a0db-66215150a6e4",
  "fees": [
    {
      "type": "FEE_ACH",
      "description": "Fee - ACH",
      "amount": -5.99,
      "wlpFinTranTypeID": "c43bab85-2916-4831-a0db-66215150a6e4",
      "transactionCode": "JOURNAL",
      "finTranReference": "HG.cd22a78a-8a48-441c-89d2-ea400964a34b",
      "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"
}