Sign in

v1

latestOpenAPI 3.0.22026-07-24113565544.0 KB
Withdrawals

List Withdrawals

Retrieves a list of Withdrawals.

get/funding/redemptions

Query parameters

status'STARTED' | 'PENDING' | 'SUCCESSFUL' | 'FAILED' | 'OTHER' | 'RIA_PENDING' | 'RIA_APPROVED' | 'RIA_REJECTED' | 'APPROVED' | 'REJECTED' | '-' required

The current status of the user's redemption/withdrawal.

Example:PENDING

The current status of the withdrawal to filter by.

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

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

Example:ACH

The type of withdrawal to filter by.

fromstring required

The date to start from.

tostring required

The date to end at.

direction'prev' | 'next'

The direction of pagination.

parentIBIDstring

The partner's unique identifier.

Example:80f9b672-120d-4b73-9ccv9-42fb3262c4b9

Filters the withdrawals list by the partnerID.

Response

Retrieving a list of Withdrawals was Successful.

idstring

The unique identifier of the redemption/withdrawal.

paymentIDstring

The unique identifier of the redemption/withdrawal.

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.

amountnumber

The amount of the withdrawal

wlpFinTranTypeIDstring

A unique identifier to id different type of transactions.

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",
    "paymentID": "-RIUIN",
    "type": "ACH",
    "amount": 125.92,
    "currency": {
      "name": "USD",
      "description": "US Dollar",
      "symbol": "$"
    },
    "status": {
      "id": 1,
      "message": "PENDING",
      "updated": "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"
      }
    },
    "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": "$"
      }
    ],
    "wlpFinTranTypeID": "c43bab85-2916-4831-a0db-66215150a6e4",
    "transactionCode": {
      "code": "JOURNAL",
      "type": "CSR",
      "description": "Cash Receipt - ACH"
    },
    "iraDistribution": "EARLY_DISTRIBUTION_PENALTY_EXCEPTION",
    "iraDistributionSubType": "SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72T"
  }
]