Copy PageCreate Withdrawalpost https://bo-api.drivewealth.io/back-office/funding/redemptionsCreates a Withdrawal.Body ParamsaccountNostringrequiredThe user's unique account number, that is human readable.amountnumberrequiredThe amount of the withdrawal. Accepts positive or negative values; regardless of the sign provided, the withdrawal is stored and processed as a negative amount in the system.currencystringenumrequiredThe name of the currency in abbreviation form.Show DetailsUSDU.S. Dollar.USDUSDAllowed:USDtypestringenumrequiredThe method/form in which the redemption/withdrawal will be sent back to the user's external account.Show DetailsACHSent via ACH transfer.WIRESent via wire transfer.CASH_TRANSFERSent via cash transfer.BULK_FUNDINGSent via bulk funding.ACHACHWIRECASH_TRANSFERBULK_FUNDINGAllowed:ACHWIRECASH_TRANSFERBULK_FUNDINGbankAccountIDstringThe unique DriveWealth identifier that identifies each linked bank account.detailsobjectThe necessary recipient details for completing a wire paymentdetails objectiraDistributionstringenumThe 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.Show DetailsNORMAL_DISTRIBUTIONA normal distribution.EARLY_DISTRIBUTIONAn early distribution, subject to penalty.EARLY_DISTRIBUTION_PENALTY_EXCEPTIONAn early distribution that qualifies for a penalty exception.DIRECT_ROLLOVERA direct rollover to another retirement account.DIRECT_TRANSFERA direct transfer to another retirement account.REQUIRED_MINIMUM_DISTRIBUTIONA required minimum distribution (RMD).DISTRIBUTION_TO_BENEFICIARYA distribution to a beneficiary.RETURN_OF_EXCESS_CONTRIBUTIONA return of an excess contribution.QUALIFIED_CHARITABLE_CONTRIBUTIONA qualified charitable distribution (QCD).EARLY_DISTRIBUTION_PENALTY_EXCEPTIONNORMAL_DISTRIBUTIONEARLY_DISTRIBUTIONEARLY_DISTRIBUTION_PENALTY_EXCEPTIONDIRECT_ROLLOVERDIRECT_TRANSFERREQUIRED_MINIMUM_DISTRIBUTIONDISTRIBUTION_TO_BENEFICIARYRETURN_OF_EXCESS_CONTRIBUTIONQUALIFIED_CHARITABLE_CONTRIBUTIONShow 9 enum valuesiraDistributionSubTypestringenumThese types are only applicable for the distribution type EARLY_DISTRIBUTION_PENALTY_EXCEPTION. Click here for more details.",Show DetailsSUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72TStructured periodic withdrawals under Section 72(t).DISABILITY_OR_DEATHExempt from the early-distribution penalty due to disability or death.HIGHER_EDUCATION_EXPENSESUsed for tuition, books, and fees at a qualified institution.FIRST_TIME_HOME_PURCHASEUp to $10,000 used toward a first home purchase.MEDICAL_EXPENSESUsed for unreimbursed medical expenses exceeding 7.5% of adjusted gross income.HEALTH_INSURANCE_PREMIUMSUsed for health insurance premiums while unemployed for 12+ weeks.RESERVIST_DISTRIBUTIONSA distribution for a qualified reservist called to active duty.SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72TSUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72TDISABILITY_OR_DEATHHIGHER_EDUCATION_EXPENSESFIRST_TIME_HOME_PURCHASEMEDICAL_EXPENSESHEALTH_INSURANCE_PREMIUMSRESERVIST_DISTRIBUTIONSAllowed:SUBSTANTIALLY_EQUAL_PERIODIC_PAYMENTS_SEPP_72TDISABILITY_OR_DEATHHIGHER_EDUCATION_EXPENSESFIRST_TIME_HOME_PURCHASEMEDICAL_EXPENSESHEALTH_INSURANCE_PREMIUMSRESERVIST_DISTRIBUTIONSiraTaxWithholdingsobjectiraTaxWithholdings objectliquidatebooleanTrue, if the account is a managed account and a full liquidation is requested from the user.falsetruefalsefeesarrayA list of fees associated to the withdrawal.feesADD feeObjectnotestringA way to store a message/comment on the this object.remittanceInformationstringFor 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.settlementProfileIDstringA settlement profile identifier that links to a specific bank account for fund settlement.metadataobjectThe metadata object allows for creating a maximum of 10 keys (max 36 characters) and each value cannot exceed 512 bytes.metadata objectHeadersIdempotency-KeystringA unique key (UUID) that is used to prevent duplicate requests. Should a network interruption occur, or you otherwise lost a response from the API, you can safely perform the request provided that you send the same value as the Idempotency-Key. DriveWealth Idempotency Keys are saved for 4 days. Within this time period, sending any request with a duplicate key will return the exact same response as the original request, including the same status code and payload.Responses 200Creating a User's Account Withdrawal was successful. 400Bad RequestUpdated 4 months ago List User WithdrawalsRetrieve WithdrawalDid this page help you?YesNo
